GetOrderItems

Definition

Use this call to get the item information of an order.

Request URI: https://api.sellercenter.lazada.sg?Action=GetOrderItems

Parameters

FieldTypeDescription
ActionstringGetOrderItems
Name of the API that is to be called. Mandatory.
FormatstringThe response format, with XML as the default. Can be XML or JSON. Optional.
TimestampdatetimeThe current time in ISO8601 format (e.g., Timestamp=2016-04-01T10:00:00+02:00 for Berlin). Mandatory.
UserIDstringThe ID of the user making the call. Mandatory.
VersionstringThe API version against which this call is to be executed. The current version is "1.0". Mandatory.
SignaturestringThe cryptographic signature, authenticating the request. You must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory.
OrderIdlongThe identifier that was assigned to the order by the Seller Center.

Code sample

# GetOrderItems cURL example
# to run, update Timestamp and recompute Signature
#
url = "https://api.sg.ali-lazada.com/"
get
data-urlencode Action=GetOrderItems
data-urlencode OrderId=1
data-urlencode Timestamp=2015-07-01T11:11+0000
data-urlencode [email protected]
data-urlencode Version=1.0
data-urlencode Signature=d4ff93cccb165295ed8357fe42082208b781a3b576bbb7d3fe7a624270b047b9
GetOrderItems request = new GetOrderItems(6642038L);
try {
  GetOrderItemsResponse response = request.execute();
  for (OrderItem orderItem: response.getBody()) {
    System.out.println(orderItem);
  }
} catch (LazadaException e) {
  System.out.println(e.getResponseStr());
}

Response

NameTypeDescription
OrderItemIdlongOrder item ID
ShopIdlongSeller name
OrderIdlongOrder ID
NamestringProduct name
SkustringProduct SKU
ShopSkustringProduct outer ID in the BOB system
ShippingTypestring1. Drop-shipping
2. Warehouse
ItemPricebigdecimalProduct price
PaidPricebigdecimalPaid price = item price - voucher
CurrencystringISO 4217 compatible currency code
WalletCreditsstringNot used
TaxAmountbigdecimalTax amount
ShippingAmountbigdecimalShipping fee
ShippingServiceCostbigdecimalShipping service cost
VoucherAmountbigdecimalVoucher
VoucherCodestringNot used
Statusstring1. Pending
2. ReadyToShip
3. Shipped
4. Delivered
5. Failed_Delivery
6. Return
ShipmentProviderstring3PL shipment provider, such as LEX
IsDigitalboolIs digital goods or not
DigitalDeliveryInfostringNot used
TrackingCodestringTracking code retrieved from 3PL shipment provider
TrackingCodePrestringNot used
ReasonstringCancel, Return or other reason,
defined in the table sales_order_reason
ReasonDetailstringReason detail
PurchaseOrderIdlongReturned by OMS when calling SetPackedByMarketPlace
PurchaseOrderNumberstringReturned by OMS when calling SetPackedByMarketPlace
PackageIdstringPackage source id, returned by OMS system
PromisedShippingTimedatetimeNot used
ExtraAttributesstring
JSON
JSON encoded string with extra attributes
ShippingProviderTypestringOne of the following options:
Express, Standard, or Economy
CreatedAtdatetimeTime of the feed's creation in ISO 8601 format
UpdatedAtdatetimeTime of the feed's last update in ISO 8601 format

Result sample

A success result sample is as follows.

<SuccessResponse>
  <Head>
    <RequestId>0a14301714882890309732151e</RequestId>
    <RequestAction>GetOrderItems</RequestAction>
    <ResponseType>OrderItems</ResponseType>
    <Timestamp>2017-02-28T21:37:11+08:00</Timestamp>
  </Head>
  <Body>
    <OrderItems>
      <OrderItem>
        <OrderItemId>100967189</OrderItemId>
        <ShopId>migrationtest2</ShopId>
        <OrderId>100663397</OrderId>
        <Name>Test please do not shoot a sku</Name>
        <Sku>545252329001-3452605530003</Sku>
        <ShopSku>OE702FAAA7HM6ASGAMZ-14920937</ShopSku>
        <ShippingType>Dropshipping</ShippingType>
        <ItemPrice>4.40</ItemPrice>
        <PaidPrice>4.40</PaidPrice>
        <Currency>SGD</Currency>
        <WalletCredits>0.00</WalletCredits>
        <TaxAmount>0.00</TaxAmount>
        <ShippingAmount>1.00</ShippingAmount>
        <ShippingServiceCost>0</ShippingServiceCost>
        <VoucherAmount>0.00</VoucherAmount>
        <VoucherCode>
        </VoucherCode>
        <Status>pending</Status>
        <ShipmentProvider>LGS-FM50</ShipmentProvider>
        <IsDigital>0</IsDigital>
        <DigitalDeliveryInfo>
        </DigitalDeliveryInfo>
        <TrackingCode>LZD5000000000311SG</TrackingCode>
        <TrackingCodePre>
        </TrackingCodePre>
        <Reason>
        </Reason>
        <ReasonDetail>
        </ReasonDetail>
        <PurchaseOrderId>1981744</PurchaseOrderId>
        <PurchaseOrderNumber>MPDS-M170861324375076219444</PurchaseOrderNumber>
        <PackageId>MPDS-303172379-1927</PackageId>
        <PromisedShippingTime>
        </PromisedShippingTime>
        <ExtraAttributes>null</ExtraAttributes>
        <ShippingProviderType>standard</ShippingProviderType>
        <CreatedAt>2017-02-26 15:52:00</CreatedAt>
        <UpdatedAt>2017-02-28 21:35:04</UpdatedAt>
        <ReturnStatus>
        </ReturnStatus>
        <productMainImage>http://sg-live-02.slatic.net/p/7/test-please-do-not-shoot-a-sku-3703-20297521-a6ee04ac9d93d572c22b92d3a3a00afa-catalog.jpg</productMainImage>
        <Variation>Not Specified</Variation>
        <ProductDetailUrl>http://www.lazada.sg/12579202.html</ProductDetailUrl>
      </OrderItem>
      <OrderItem>
        <OrderItemId>100967191</OrderItemId>
        <ShopId>migrationtest2</ShopId>
        <OrderId>100663397</OrderId>
        <Name>Test please do not shoot a sku</Name>
        <Sku>545252329001-3452605530003</Sku>
        <ShopSku>OE702FAAA7HM6ASGAMZ-14920937</ShopSku>
        <ShippingType>Dropshipping</ShippingType>
        <ItemPrice>4.40</ItemPrice>
        <PaidPrice>4.40</PaidPrice>
        <Currency>SGD</Currency>
        <WalletCredits>0.00</WalletCredits>
        <TaxAmount>0.00</TaxAmount>
        <ShippingAmount>1.00</ShippingAmount>
        <ShippingServiceCost>0</ShippingServiceCost>
        <VoucherAmount>0.00</VoucherAmount>
        <VoucherCode>
        </VoucherCode>
        <Status>pending</Status>
        <ShipmentProvider>LGS-FM50</ShipmentProvider>
        <IsDigital>0</IsDigital>
        <DigitalDeliveryInfo>
        </DigitalDeliveryInfo>
        <TrackingCode>LZD5000000000311SG</TrackingCode>
        <TrackingCodePre>
        </TrackingCodePre>
        <Reason>
        </Reason>
        <ReasonDetail>
        </ReasonDetail>
        <PurchaseOrderId>1981744</PurchaseOrderId>
        <PurchaseOrderNumber>MPDS-M170861324375076219444</PurchaseOrderNumber>
        <PackageId>MPDS-303172379-1927</PackageId>
        <PromisedShippingTime>
        </PromisedShippingTime>
        <ExtraAttributes>null</ExtraAttributes>
        <ShippingProviderType>standard</ShippingProviderType>
        <CreatedAt>2017-02-26 15:52:00</CreatedAt>
        <UpdatedAt>2017-02-28 21:35:04</UpdatedAt>
        <ReturnStatus>
        </ReturnStatus>
        <productMainImage>http://sg-live-02.slatic.net/p/7/test-please-do-not-shoot-a-sku-3703-20297521-a6ee04ac9d93d572c22b92d3a3a00afa-catalog.jpg</productMainImage>
        <Variation>Not Specified</Variation>
        <ProductDetailUrl>http://www.lazada.sg/12579202.html</ProductDetailUrl>
      </OrderItem>
      <OrderItem>
        <OrderItemId>100967192</OrderItemId>
        <ShopId>migrationtest2</ShopId>
        <OrderId>100663397</OrderId>
        <Name>Test please do not shoot a sku</Name>
        <Sku>545252329001-3452605530003</Sku>
        <ShopSku>OE702FAAA7HM6ASGAMZ-14920937</ShopSku>
        <ShippingType>Dropshipping</ShippingType>
        <ItemPrice>4.40</ItemPrice>
        <PaidPrice>4.40</PaidPrice>
        <Currency>SGD</Currency>
        <WalletCredits>0.00</WalletCredits>
        <TaxAmount>0.00</TaxAmount>
        <ShippingAmount>1.00</ShippingAmount>
        <ShippingServiceCost>0</ShippingServiceCost>
        <VoucherAmount>0.00</VoucherAmount>
        <VoucherCode>
        </VoucherCode>
        <Status>pending</Status>
        <ShipmentProvider>LGS-FM50</ShipmentProvider>
        <IsDigital>0</IsDigital>
        <DigitalDeliveryInfo>
        </DigitalDeliveryInfo>
        <TrackingCode>LZD5000000000311SG</TrackingCode>
        <TrackingCodePre>
        </TrackingCodePre>
        <Reason>
        </Reason>
        <ReasonDetail>
        </ReasonDetail>
        <PurchaseOrderId>1981744</PurchaseOrderId>
        <PurchaseOrderNumber>MPDS-M170861324375076219444</PurchaseOrderNumber>
        <PackageId>MPDS-303172379-1927</PackageId>
        <PromisedShippingTime>
        </PromisedShippingTime>
        <ExtraAttributes>null</ExtraAttributes>
        <ShippingProviderType>standard</ShippingProviderType>
        <CreatedAt>2017-02-26 15:52:00</CreatedAt>
        <UpdatedAt>2017-02-28 21:35:04</UpdatedAt>
        <ReturnStatus>
        </ReturnStatus>
        <productMainImage>http://sg-live-02.slatic.net/p/7/test-please-do-not-shoot-a-sku-3703-20297521-a6ee04ac9d93d572c22b92d3a3a00afa-catalog.jpg</productMainImage>
        <Variation>Not Specified</Variation>
        <ProductDetailUrl>http://www.lazada.sg/12579202.html</ProductDetailUrl>
      </OrderItem>
    </OrderItems>
  </Body>
</SuccessResponse>

Error messages

Error codeMessage
16E016: "%s" Invalid Order ID