SetStatusToReadyToShip

Mark an order item as being ready to ship.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The API responds by sending purchase order details in the response:

PurchaseOrderIdUnsignedSeller Center
identification
PurchaseOrderNumberStringOrder number in
Seller Center

Errors

Error codeMessageExplanation
20E020: "%s" Invalid Order Item ID
21E021: OMS Api Error Occurred
23E023: "%s" Invalid Order Item IDs
25E025: "%s" Invalid Shipping Provider
26E026: "%s" Invalid Tracking Number
29E029: Order items must be from the same order
31E031: Tracking ID incorrect. Example tracking ID: "%s"
73E073: All order items must have status Pending or Ready To Ship. (%s)
63E063: The tracking code %s has already been used
91E091: You are not allowed to set the shipment provider and tracking number and the delivery type is wrong. Please use send_to_warehouse
119E119: Some order items are not yet ready to be processed, please try again later. (%s).One or more order items are not fully handled by Seller Center, so they cannot be processed yet.
121E121: Invalid Packing ID
Form Data
string
Defaults to GetBrands

Name of the function that is to be called. Mandatory and must be 'SetStatusToReadyToShip' in this case. If omitted, an 'E001: Parameter Action is mandatory' error is returned. If an unknown function string is supplied, an 'E008: Invalid Action' error message is returned.

string
Defaults to XML

If supplied, must be either 'JSON' or 'XML'. If not supplied, 'XML' is assumed.

date

The current time in ISO8601 format relative to UTC (e.g., Timestamp=2015-04-01T10:00:00+02:00 for Berlin), so that calls cannot be replayed by an eaves-dropping third party (i.e., those calls too far into the past or future yield an error message). Mandatory. If not supplied, an 'E001: Parameter Timestamp is mandatory' error message results. If the timestamp is too old or in the future, an 'E003: Timestamp has expired' error message is returned.

string

The ID of the user making the call. The list of authorized users is maintained in Seller Center web interface under Settings/Manage Users.

string

The API version against which this call is to be executed, in major-dot-minor format. Must currently be 1.0, even though the actual version of the API is 2.6.20. If omitted, an ‘E001: Parameter Version is mandatory’ error message is returned.

string

The cryptographic signature, authenticating the request. A caller 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. If omitted, an ‘E001: Parameter Signature is mandatory’ error message is returned. If the signature is incorrect, an ‘E007: Login failed. Signature mismatch’ error message is returned.

OrderItemIds
array of int32s

List of oder items to be marked ready to ship. You can get it from GetOrderItems. Comma separated list in square brackets. Mandatory.

OrderItemIds
string

One of the following: '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 (crossdocking). Mandatory

string

Valid shipment provider as looked up via GetShipmentProviders (supply the name as returned by the Name tag(s)). Mandatory always drop-shipping and mandatory of cross-docking when DeliveryType 'send_to_warehouse' is used

string

The actual tracking number, needs to be provided when passed ShppingProvider does not have API integration enabled

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/xml
application/json