API Reference

Calls the partner's configured returns service to create a return label.

post
https://api.shipium.com/api/v1/deliveryexperience/customerreturn/label
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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.

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

boolean

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

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.

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

string

String passed to carriers as a reference.

string

String passed to carriers as a reference2.

string

String passed to carriers as a reference3.

string

String passed to carriers as a reference4.

string

String passed to carriers as a reference5.

string

Partner custom reference to a return label.

string

Partner custom reference to a return label.

Headers
string
Responses

Updated 6 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago