Skip to main content

This type specifies the shipping service information.

Type that uses ServiceInfoResponses

GetServiceListResponsesData

Call that uses ServiceInfoResponses

Fields

Field
Type
Description
descriptionEn
Basic shipping service information in English.
descriptionHk
Basic shipping service information in traditional Chinese.
descriptionJp
Basic shipping service information in Japanese.
descriptionZh
Basic shipping service information in simplified Chinese.
directions
This array lists includes all Ship From/Ship To combinations that the service supports. It also includes the type of batteries that may be shipping using the shipping service.
incoterm
The incoterm information associated with the the shipping service.

Supported values:
  • DDP
  • DDU
maxLength
This value indicates the maximum length (in centimeters) of the shipping package that the shipping service allows.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.
maxTotalLength
This value indicates the total maximum value of the length, width, and height of the package.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.
maxWeight
This value indicates the maximum weight (in grams) of the shipping package that the shipping service allows.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.
nameEn
The shipping service name in English
nameHk
The shipping service name in traditional Chinese
nameJp
The shipping service name in Japanese.
nameZh
The shipping service name in simplified Chinese
shippingServiceId
The unique identifier of the shipping service being retrieved.

This value can be input in the shippingServiceId field when creating a package through the the createPackage method.