SetStatusToReadyToShip
Definition
Use this call to mark an order item as being ready to ship.
Request URI: https://api.sellercenter.lazada.sg?Action=SetStatusToReadyToShip
Prerequisite:
Call the SetStatusToPackedByMarketPlace API before calling SetStatusToReadyToShip.
Parameters
| Field | Type | Description |
|---|---|---|
| Action | string | SetStatusToReadyToShip Name of the API that is to be called. Mandatory. |
| Format | string | The response format, with XML as the default. Can be XML or JSON. Optional. |
| Timestamp | datetime | The current time in ISO8601 format (e.g., Timestamp=2016-04-01T10:00:00+02:00 for Berlin). Mandatory. |
| UserID | long | The ID of the user making the call. Mandatory. |
| Version | string | The API version against which this call is to be executed. The current version is "1.0". Mandatory. |
| Signature | string | The 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. |
| OrderItemIds | array of long | List of oder items to be marked ready to ship. Comma separated list in square brackets. Mandatory. |
| DeliveryType | string | One of the following delivery types: 'dropship' - the seller will send out the package on his own. 'pickup' - shop should pick up the item from the seller (cross-docking). 'send_to_warehouse' - the seller will send the item to the warehouse (cross-docking). Mandatory. Now only "dropship" is supported. |
| ShippingProvider | string | Valid shipment provider as looked up via GetShipmentProviders. Mandatory for drop-shipping. |
| TrackingNumber | string | Package tracking number. Mandatory in the case of drop-shipping. |
| SerialNumber | mixed | Only applicable if the serial number feature has been enabled for platform and seller. Unique serial number for tracking order items, which can be specified as comma-separated list of serials or JSON array, in which case there must be exactly as many serials as there are OrderItemIds. Can also be specified as a JSON object where keys are order item ids and values are corresponding serial numbers. In this case the order item ID from OMS will be used as serial for items where it has not been explicitly specified. Optional. |
Code sample
# SetStatusToReadyToShip cURL example
# to run, update Timestamp and recompute Signature
#
url = "https://api.sg.ali-lazada.com/"
get
data-urlencode Action=SetStatusToReadyToShip
data-urlencode OrderItemIds=[1]
data-urlencode DeliveryType=dropship
data-urlencode ShippingProvider=Aramax
data-urlencode TrackingNumber=123456789
data-urlencode Timestamp=2015-07-01T11:11+0000
data-urlencode [email protected]
data-urlencode Version=1.0
data-urlencode Signature=d4ff93cccb165295ed8357fe42082208b781a3b576bbb7d3fe7a624270b047b9
//init request with OrderItemId list, DeliveryType, ShippingProvider, TrackingNumber
List<Long> orderItemIds = Arrays.asList(102612420L, 102612419L);
SetStatusToReadyToShip request = new SetStatusToReadyToShip(orderItemIds, DeliveryType.Dropship, "SkyNet - DS", "23873905618");
try {
UpdateResponse response = request.execute();
System.out.println("Update status succeed?" + response.getBody());
} catch (LazadaException e) {
System.out.println(e.getResponseStr());
}
Response
The API responds by sending purchase order details in the response:
| Name | Type | Description |
|---|---|---|
| PurchaseOrderId | long | Seller Center identification. Optional, please ignore it if your business scenario does not cover it. |
| PurchaseOrderNumber | string | Order number in the Seller Center. Optional, please ignore it if your business scenario does not cover it. |
Result sample
<?xml version="1.0" encoding="UTF-8"?>
<SuccessResponse>
<Head>
<RequestId></RequestId>
<RequestAction>SetStatusToReadyToShip</RequestAction>
<ResponseType>OrderItems</ResponseType>
<Timestamp>2013-08-27T14:44:13+0000</Timestamp>
</Head>
<Body>
<OrderItems>
<OrderItem>
<PurchaseOrderId>123456</PurchaseOrderId>
<PurchaseOrderNumber>ABC-123456</PurchaseOrderNumber>
</OrderItem>
</OrderItems>
</Body>
</SuccessResponse>
Error messages
| Error code | Message | Explanation |
|---|---|---|
| 20 | E020: "%s" Invalid Order Item ID | |
| 21 | E021: OMS Api Error Occurred | |
| 23 | E023: "%s" Invalid Order Item IDs | |
| 24 | E024: "%s" Invalid Delivery Type | |
| 25 | E025: "%s" Invalid Shipping Provider | |
| 26 | E026: "%s" Invalid Tracking Number | |
| 29 | E029: Order items must be from the same order | |
| 31 | E031: Tracking ID incorrect. Example tracking ID: "%s" | |
| 63 | E063: The tracking code %s has already been used | |
| 73 | E073: All order items must have status Pending or Ready To Ship. (%s) | |
| 91 | E091: You are not allowed to set the shipment provider and tracking number and the delivery type is wrong. Please use sent_to_warehous | |
| 94 | E094: Serial numbers specified incorrectly | Serial numbers were not specified according to one of the accepted formats for the SerialNumber parameter. |
| 95 | E095: Invalid serial number format (%s) | Serial numbers must be 1 to 26 characters; only latin letters and digits are allowed. |
| 96 | E096: Duplicate serial number among order items (%s) | Two or more items in the order would share a serial number. |
Updated almost 7 years ago