GetShipmentProviders

Definition

Use this call to get the list of all active shipping providers, which is needed when working with the SetStatusToPackedByMarketplace call.

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

Parameters

Field	Type	Description
Action	string	GetShipmentProviders 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	string	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.

Code sample

# GetShipmentProviders cURL example
# to run, update Timestamp and recompute Signature
#
url = "https://api.sg.ali-lazada.com/"
get
data-urlencode Action=GetShipmentProviders
data-urlencode Timestamp=2015-07-01T11:11+0000
data-urlencode [email protected]
data-urlencode Version=1.0
data-urlencode Signature=d4ff93cccb165295ed8357fe42082208b781a3b576bbb7d3fe7a624270b047b9

GetShipmentProviders request = new GetShipmentProviders();
try {
  GetShipmentProvidersResponse response = request.execute();
  for (ShipmentProvider provider: response.getBody()) {
    System.out.println(provider);
  }
} catch (LazadaException e) {
  System.out.println(e.getResponseStr());
}

Response

The detailed shipment provider information is returned.

Name	Type	Description
Name	string	Name of the shipment provider. This is the string that is needed for SetStatusToPackedByMarketplace.
Default	boolean	This shipment provider will be the standard selection for order processing.
ApiIntegration	boolean	Value will be 1 if this shipment provider has an API.
Cod	boolean	The shipment provider will be available for cash on delivery orders.
TrackingCodeValidationRegex	string	The regular expression for validation of tracking code. Example: /^[a-z0-9]{10}$/i Please check using http://regex101.com/#pcre.
TrackingCodeExample	string	The example of tracking code.
TrackingUrl	string	Shipment provider's tracking URL. Placeholder {{{TRACKING_NR}}} can be used for tracking code. Otherwise tracking code should be appended to the end of tracking URL.
EnabledDeliveryOptions	array	Shipment provider's speed eligibility, which could be multiple values. Possible values are economy, standard, and express.

Result sample

<?xml version="1.0" encoding="UTF-8"?>
<SuccessResponse>
  <Head>
    <RequestId></RequestId>
    <RequestAction>GetShipmentProviders</RequestAction>
    <ResponseType>ShipmentProvider</ResponseType>
    <Timestamp>2013-08-27T14:44:13+0000</Timestamp>
  </Head>
  <Body>
    <ShipmentProviders>
      <ShipmentProvider>
        <Name>GDEX</Name>
        <Default>0</Default>
        <ApiIntegration>0</ApiIntegration>
        <Cod>0</Cod>
        <TrackingCodeValidationRegex>/^[0-9]{20}$/</TrackingCodeValidationRegex>
        <TrackingCodeExample>12345678901234567890</TrackingCodeExample>
        <TrackingUrl>http://intranet.gdexpress.com/official/etracking.php?capture={{{TRACKING_NR}}}</TrackingUrl>
        <EnabledDeliveryOptions>
          <DeliveryOption>express</DeliveryOption>
          <DeliveryOption>standard</DeliveryOption>
          <DeliveryOption>economy</DeliveryOption>
        </EnabledDeliveryOptions>
      </ShipmentProvider>
    </ShipmentProviders>
  </Body>
</SuccessResponse>

Error messages

No specific errors.