Get Shipping Label

get

https://sellercenter-api.falabella.com/?Action=GetDocument

GetDocument. Retrieves the shipping labels for an order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The response fields provided by this API are detailed in the following table:

Field Name	Type	Description
DocumentType	String	Document type requested in the API call
MimeType*	String	Can have the values text/plain or application/pdf. text/plain indicates the type of decoding to be used to convert from base64 to plain text (.txt or .zpl). application/pdf is the decoding to be used to convert from base64 to pdf. Currently, text/plain only applies to Chile.
File	String	Label encoded in BASE64

*The MimeType returned in the call is based on the format type previously requested by the seller. Changing the format requires creating a ticket in the Seller Support platform; at the moment, this request can only be made for sellers in Chile.

To reconstruct the file, the data from the <File> node must be decoded in base64 and interpreted according to the <MimeType>.

🚧
How to request your ZPL label?
You must create a ticket through the support button in Falabella Seller Center, selecting
Post Sale > Pending Order Dispatch > I want to receive my labels in ZPL format
Currently, this applies only to Chile.

Errors

Error Code	Message
20	E020: "%s" Invalid Order Item IDs (Invalid order item IDs)
21	E021: OMS Api Error Occurred (An error occurred in the API)
32	E032: Document type "%s" is not valid (The document type "%s" is not valid)
34	E034: Order Item must be packed. Please call setStatusToReadyToShip before (The order item must be packed. Please call setStatusToReadyToShip)
35	E035: "%s" was not found ("%s" was not found)

Query Params

Action

string

required

Defaults to GetDocument

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

Format

string

required

Defaults to XML

If provided, it must be 'JSON' or 'XML'. If not provided, 'XML' is assumed.

Timestamp

date

required

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 a third party intercepting them (i.e., calls too far in the past or future will produce an error message). Required. If not provided, the error message 'E001: Parameter Timestamp is mandatory' appears. If the timestamp is too old or in the future, an error message "E003: Timestamp has expired" is returned.

UserID

string

required

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

Version

string

required

The API version against which this call will be executed, in major-dot-minor format. It must currently be 1.0, although the actual API version is 2.6.20. If omitted, an error message "E001: Parameter Version is mandatory" is returned.

Signature

string

required

The cryptographic signature that authenticates the request. A caller must create this value by calculating the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Required. If omitted, an error message "E001: Parameter Signature is mandatory" is returned. If the signature is incorrect, an 'E007: Login failed' error message for signature mismatch is returned.

DocumentType

string

required

Defaults to ShippingParcel

This field must have the value shippingParcel. Required. If omitted, or if an unsupported document type is provided, an error "E032: The document type '[provided type]' is not valid" will occur.

OrderItemIds

array of int32s

required

Order position identifier for which the caller wishes to obtain a document. Required. GetOrderItems

OrderItemIds*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

How to request your ZPL label?

Errors

200200

400400