GetShipmentProviders

Returns a list of all active shipping providers.
Needed when working with SetStatusToShipped.

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

The reason for each failure is given inside the following elements of the XML response:

NameStringName of the shipper. This is the string that is needed for SetStatusToShipped.
DefaultBooleanThis shipment provider will be the standard selection for order processing
ApiIntegrationBooleanValue will be 1, if this shipper have an API
CodBooleanThe shipment provider will be available for cash on delivery orders
TrackingCodeValidationRegexStringThe regular expression for validation of tracking code.
Example: /^[a-z0-9]{10}$/i Please check using http://regex101.com/#pcre
TrackingCodeExampleStringThe example of tracking code
TrackingUrlStringShipper's tracking URL.
Placeholder {{{TRACKING_NR}}} can be used for tracking code. Otherwise tracking code should be appended to the end of tracking URL.
EnabledDeliveryOptionsArrayShipment provider's speed eligibility, could be multiple. Possible values are economy, standard and express

Errors

No specific errors.

Query Params
string
Defaults to GetShipmentProviders

Name of the function that is to be called. Mandatory and must be 'GetShipmentProviders' 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.

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