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

• destinationAddress

  • object
  • required
  • Address details of the sold to party for customs purposes

• labelParameters

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

• generateLabel

  • boolean
  • Whether or not to generate a return label. This defaults to true.
  • true / false

• packagingType

  • object
  • Fields describing the physical properties of the package.

• totalWeight

  • object
  • The weight of this type of packaging empty.

• orderItemQuantities

  • array of objects
  • A list of orderItems being returned.

• 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.

Codes

• 200 Label generated for the return.
• 400 Invalid inputs were provided.

Example Request

curl --request POST \
     --url https://api.shipium.com/api/v1/deliveryexperience/customerreturn/label \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response Codes

• 200
• 400