URL Expired

The URL for this request expired after 30 days.

Params used to request the carrier to generate a return shipping label. This field will be null if the request is to generate a normal shipping label.

customerReturnParams

object

required

Details of the customer return required for label generation by the carriers.

customerReturnParams object

originAddress

object

required

Address details of the sold to party for customs purposes

originAddress object

destinationAddress

object

required

Address details of the sold to party for customs purposes

destinationAddress object

labelParameters

object

required

Information on the types of labels to be generated by the carrier, as well as if a manifest for the shipment is generated. This field is ignored if the "generateLabel" field is set to "false".

labelParameters object

generateLabel

boolean

Whether or not to generate a return label. This defaults to true.

truefalse

packagingType

object

Fields describing the physical properties of the package.

packagingType object

totalWeight

object

The weight of this type of packaging empty.

totalWeight object

orderItemQuantities

array of objects

A list of orderItems being returned.

orderItemQuantities ADD object

tenantId

string

Either the shipium tenant ID or the partner provided tenant ID. When present, this is used to indicate the tenant associated with the shipment.

referenceIdentifier

string

String passed to carriers as a reference.

referenceIdentifier2

string

String passed to carriers as a reference2.

referenceIdentifier3

string

String passed to carriers as a reference3.

referenceIdentifier4

string

String passed to carriers as a reference4.

referenceIdentifier5

string

String passed to carriers as a reference5.

partnerReferenceIdentifier

string

Partner custom reference to a return label.

partnerReferenceIdentifier2

string

Partner custom reference to a return label.

`` 200 Label generated for the return.

`` 400 Invalid inputs were provided.

Updated 26 days ago

ShellNodeRubyPHPPython

Bearer

xxxxxxxxxx

curl --request POST \

--url https://api.shipium.com/api/v1/deliveryexperience/customerreturn/label \

--header 'accept: application/json' \

--header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200400

Updated 26 days ago