Return Labels

Provide shipment labels for your customers to return products.

About return labels

Many retail companies enable their customers to send back products due to issues with a product or as part of their business model. Most shipping carriers have a different return method that enables you, the shipper, to:

  • not get charged for shipping the package until the label is scanned (some carriers do charge a fee per requested return label, however);
  • print a label with a tentative weight or no weight at all; and
  • specify your fulfillment center as the destination and a customer location as the origin.

The Shipium system supports return label generation and offers three ways for you to retrieve a return shipment label:

  • Generate a return label at the same time as shipment label generation. This method involves including additional data fields when calling the Carrier and Method Selection & Shipment Label API. Instructions are included in this document.
  • Generate a return label independent of shipment label generation. This method involves calling the Return Label API. Instructions are included in the Return Label API document.
  • Print ad-hoc return labels from the Shipium Console. This method satisfies the need to create ad-hoc return labels for customers. Guidance is included in the Print Labels document.

You also can retrieve previously created return labels via an API call.

πŸ‘‰

Test mode

Want to run some examples and not charge any real money against your account?

You can add testMode: "true" to the data passed to any label call to retrieve labels without charging money in a carrier-specific manner. Most carriers will mark their labels in a way to make clear that they are void, such as inserting "VOID" throughout the label or using a predefined ID.

Examples below all contain the testMode flag to err on the side of caution – remove it to make production calls.

Generate a return label at the same time as shipment label generation

With this option, you can make a single call to Shipium's Carrier and Method Selection & Shipment Label API and receive both an outbound shipping label and a return label rate shopped across three national carriers: FedEx, United Parcel Service (UPS), and United States Postal Service (USPS).

πŸ“˜

Authentication for API calls

In the cURL examples on this page, the environment variable AUTHSTRING is used to handle authorization. The recipe below shows how to set it correctly for both API key and OAuth users.

The Carrier and Method Selection & Shipment Label API document provides an overview of special cases that can be handled when calling the API, such as hazardous material. Those same cases are supported for return labels as well.

The following table provides required and optional field descriptions for calling to retrieve a return label and shipment label simultaneously. You can find additional support in Carrier and Method Selection & Shipment Label API Reference.

Request fieldRequired/OptionalField propertiesDescription
inlineReturnsLabel .partnerShipmentIdOptionalStringAn optional unique identifier that your organization may use for this shipment
inlineReturnsLabel .returnToAddress .countryCodeRequiredString
Example: US
The ISO 3166-1 country code for the address
inlineReturnsLabel .returnToAddress .postalCodeRequiredString
Example: 87121
A country-code-appropriate postal code for the address
inlineReturnsLabel .returnToAddress .addressTypeOptionalString
Values are:

- Commercial
- Residential
The type of location for this address
inlineReturnsLabel .returnToAddress.cityOptionalStringThe name of the city for the address
inlineReturnsLabel .returnToAddress .companyOptionalStringThe company name for the address
inlineReturnsLabel .returnToAddress .emailAddressOptionalStringThe email address for the contact
inlineReturnsLabel .returnToAddress.nameOptionalStringThe name associated with the address
inlineReturnsLabel .returnToAddress .phoneNumberOptionalStringThe phone number for the contact
inlineReturnsLabel .returnToAddress.stateOptionalStringThe 2-letter abbreviation of the state for the address
inlineReturnsLabel .returnToAddress .street1OptionalStringThe first address line
inlineReturnsLabel .returnToAddress .street2OptionalStringThe second address line
inlineReturnsLabel .returnToContactInfo .contactNameOptionalStringThe name of the contact for the return-to address
inlineReturnsLabel .returnToContactInfo .phoneNumberOptionalStringThe phone number of the contact for the return-to address
inlineReturnsLabel .returnToContactInfo .phoneNumberCountryCodeOptionalStringThe phone number country code of the contact for the return-to address
inlineReturnsLabel .returnToContactInfo .emailOptionalStringThe email address of the contact for the return-to address
inlineReturnsLabel .fulfillmentContextOptional, but required for multiple returns in the shipmentStringWhen present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillment context for the returns.
currencyCodeOptionalStringCurrency in which all the rates for shipping carrier selection costs will be calculated
generateLabelOptionalBoolean
True or False
When true, a request to the selected carrier will be sent to generate a label for the shipment based on the information provided in the labelParameters field of this object. When false, this step is skipped and the system will record what carrier service method would have generated a label for.
labelParameters .currencyCodeOptionalStringCurrency in which all the rates for shipping carrier selection costs will be calculated
labelParameters .customLabelEntriesOptionalStringList of formats to generate the package label in
labelParameters .includeLabelImagesIn ResponseOptionalBoolean
True or False
If true, the response will include the raw image data of the labels that were requested to be generated by the carrier.
labelParameters .labelFormatsOptionalString
Supported formats are:

- PDF
- PNG
- ZPL
List of formats to generate the package label in
labelParameters .manifestOptionalBoolean
True or False
If true, a manifest for the label is generated.
labelParameters .testModeOptionalBoolean
True or False
If true, no actual labels are created, only a representation of the label. No money is charged to the underlying account.
labelParameters .contentDescriptionRequired, for returnsStringA brief description of the contents being returned that is passed to the carrier; must be 1-35 characters
shipmentParameters .destinationAddress .countryCodeRequiredString The ISO 3166-1 country code for the address
shipmentParameters .destinationAddress .postalCodeRequiredStringA country-code-appropriate postal code for the address
shipmentParameters .destinationAddress .addressTypeOptionalString
Values are:

- Commercial
- Residential
The type of location for the destination address
shipmentParameters .destinationAddress .cityOptionalStringThe name of the city for the destination address
shipmentParameters .destinationAddress .companyOptionalStringThe company name for the destination address
shipmentParameters .destinationAddress .emailAddressOptionalStringThe email address of the contact for the destination address
shipmentParameters .destinationAddress .nameOptionalStringThe name of the contact for the destination address
shipmentParameters .destinationAddress .phoneNumberOptionalStringThe phone number of the contact for the destination address
shipmentParameters .destinationAddress .stateOptionalStringThe 2-letter postal abbreviation of the state for the destination address
shipmentParameters .destinationAddress .street1OptionalStringThe first address line
shipmentParameters .destinationAddress .street2OptionalStringThe second address line
shipmentParameters .orderItemQuantities .productDetailsRequiredStringA list of properties that may affect the shipping of the product
shipmentParameters .orderItemQuantities .productIdRequiredStringA product ID for the product being checked (ISBN, UPC, etc.)
shipmentParameters .orderItemQuantities .quantityRequiredInteger ($int32)The number of units of the product
shipmentParameters .orderItemQuantities .deliveryEstimateIdOptionalStringThe Delivery Estimate ID associated with the product
shipmentParameters .orderItemQuantities .hazmatOptionalBoolean
True or False
If true, this indicates that the item is hazardous material (hazmat). The default value is false.
shipmentParameters .orderItemQuantities .shipiumOrderIdOptionalStringIdentification use to represent the group of delivery estimates purchased
shipmentParameters .shipFromAddressSee shipment parameters for the destination address for information about these fields, which apply to the origin, or ship from, address.
shipmentParameters .deliveredDateTimeOptionalString ($date-time)The timestamp for when the package was delivered to the customer; the timestamp must be a valid ISO 8601 timestamp.
shipmentParameters .desiredDeliveryDateOptionalStringThe string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date or datetime the package is intended to arrive to the customer. This is used to determine the most appropriate service method when generating a label.
shipmentParameters .fulfillmentContextOptional, but required if your organization has more than one returns type fulfillment contextStringThis is used to limit carrier selection to carrier accounts that contain a matching fulfillment context.
shipmentParameters .orderedDateTimeOptionalString ($date-time)The timestamp for when the customer placed the order for this product; the timestamp must be a valid ISO 8601 timestamp.
shipmentParameters .packagingType .linearDimensions .heightOptional, but required if the packagingTypeId is not includedNumber ($float)The least long linear dimension (i.e., the shortest side of a box or envelope). Note on envelopes: This height should represent the highest product you would reasonably put in this envelope before losing more than 10% of the length of the envelope in other dimensions.
shipmentParameters .packagingType .linearDimensions .lengthOptional, but required if the packagingTypeId is not includedNumber ($float)The longest linear dimension (i.e., the longest side of a box or envelope).
shipmentParameters .packagingType .linearDimensions .linearUnitOptional, but required if the packagingTypeId is not includedString
Values include:

- cm (centimeter)
- in (inch)
The unit in which linear dimensions are provided
shipmentParameters .packagingType .linearDimensions .widthOptional, but required if the packagingTypeId is not includedNumber ($float)The second longest linear dimension (i.e., the second longest side of a box or envelope)
shipmentParameters .packagingType .packagingMaterialOptionalString
Values include:

- box
- envelope
- flat_pack
The type of packaging used to create the package for the shipment
shipmentParameters .packagingType .packagingSizeNameOptionalString
Example: 13x12x10 Box
A custom name for the packaging
shipmentParameters .packagingType .packagingWeight .weightOptionalNumber ($float)The value of the weight
shipmentParameters .packagingType .packagingWeight .weightUnitOptionalString
Values include:

- g (gram)
- kg (kilogram)
- lb (pound)
- oz (ounce)
The unit in which weight values are provided
shipmentParameters .referenceIdentifierOptionalStringString passed to carriers as a reference
shipmentParameters .saturdayDeliveryOptionalBoolean
True or False
If true, this indicates that the shipment is marked for Saturday delivery. It does not guarantee delivery on Saturday.
shipmentParameters .shipOptionOptionalString
Example: Standard
A high-level shipping option shown to or selected by a customer
shipmentParameters .shipmentTagsOptionalStringA collection of free-form tags that may be added to the shipment
shipmentParameters .shippedDateTimeOptionalString ($date-time)The timestamp for when a partner shipped the product from their warehouse; the timestamp must be a valid ISO 8601 timestamp.
shipmentParameters .totalWeight.weightOptionalNumber ($float)The value of the weight
shipmentParameters .totalWeight .weightUnitOptionalString
Values include:

- g (gram)
- kg (kilogram)
- lb (pound)
- oz (ounce)
The unit in which weight values are provided

Example cURL request

curl --request POST   
  --url https://api.shipium.com/api/v1/shipment/carrierselection/label 
  --header 'accept: application/json' 
  --header $AUTHSTRING  
  --header 'content-type: application/json'  
  --data 'INSERT REQUEST BODY FROM BELOW'

Example request body

When requesting a return label at the same time as the original shipment label generation, you'll add the inlineReturnsLabel object to your call, as shown in the following example. The returnToAddress and returnToContact fields are optional when providing fulfillment content values; you can provide values for these fields if you wish to override any address or contact information associated with an existing fulfillment context in the Shipium platform. A fulfillment context value or a fulfillment context ID can be provided in the call to associate the return to a fulfillment context that your organization has set up for returns. You can find more information about setting up a fulfillment context in Fulfillment Contexts.

{
    "inlineReturnsLabel": {
        "partnerShipmentId": "myCustomPartnerShipmentId123",
        "returnToAddress": {
            "countryCode": "US",
            "postalCode": "17901",
            "addressType": "commercial",
            "city": "Pottsville",
            "company": "Sell It",
            "emailAddress": "[email protected]",
            "name": "Ro Drunner",
            "phoneNumber": "5555555555",
            "state": "PA",
            "street1": "401 Centre St.",
            "street2": null
        },
        "returnToContactInfo": {
            "contactName": "Ro Drunner",
            "phoneNumber": "5555555555",
            "phoneNumberCountryCode": "1",
            "email": "[email protected]"
	},
        "fulfillmentContext": "b4a3e646-4a10-4c7b-b974-1f115c9890c5"
    },
    "currencyCode": "usd",
    "generateLabel": "true",
    "labelParameters": {
        "currencyCode": "usd",
        "customLabelEntries": {},
        "includeLabelImagesInResponse": "true",
        "labelFormats": [
            "zpl"
        ],
        "manifest": "true",
        "testMode": "true",
        "contentDescription": "general merchandise"
    },
    "shipmentParameters": {
        "destinationAddress": {
            "countryCode": "US",
            "postalCode": "87121",
            "addressType": "commercial",
            "city": "Albuquerque",
            "company": "Buy It",
            "emailAddress": "[email protected]",
            "name": "Wile E. Coyote",
            "phoneNumber": "888-555-1234",
            "state": "NM",
            "street1": "123 Main St.",
            "street2": "Suite 42"
        },
        "orderItemQuantities": [
            {
                "productDetails": [
                ],
                "productId": "RN03947--Z43121",
                "quantity": 3,
                "deliveryEstimateId": "feea39ed-20c6-4b3b-98dd-34bf1d89a933",
                "hazmat": false,
                "shipiumOrderId": "b0f7037a-2f37-4df8-b350-8ee1fb6eadec"
            }
        ],
        "shipFromAddress": {
            "countryCode": "US",
            "postalCode": "17901",
            "addressType": "commercial",
            "city": "Pottsville",
            "company": "Sell It",
            "emailAddress": "[email protected]",
            "name": "Ro Drunner",
            "phoneNumber": "6612475319",
            "state": "PA",
            "street1": "401 N. Centre St.",
            "street2": null
        },
        "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
        "desiredDeliveryDate": "2019-10-31T20:00:00Z",
        "fulfillmentContext": "47e5608b-b606-426c-b3e2-b13acb1af22d",
        "orderedDateTime": "2019-10-29T09:12:33.123456Z",
        "packagingType": {
            "linearDimensions": {
                "height": 5,
                "length": 5,
                "linearUnit": "in",
                "width": 5
            },
            "packagingMaterial": "box",
            "packagingSizeName": "5x5x5 Box",
            "packagingWeight": {
                "weight": 2,
                "weightUnit": "lb"
            }
        },
        "referenceIdentifier": "PSFC-2478",
        "saturdayDelivery": false,
        "shipOption": "Standard",
        "shipmentTags": [
            "PSFC",
            "Returns"
        ],
        "shippedDateTime": "2019-10-29T09:12:33.123456Z",
        "totalWeight": {
            "weight": 10,
            "weightUnit": "lb"
        }
    }
}

Example response body

{
    "shipiumShipmentId": "ba1919a1-1c9a-4f53-93a7-8af49213be7c",
    "orderedDateTime": "2019-10-29T09:12:33.123456Z",
    "shippedDateTime": "2019-10-29T09:12:33.123456Z",
    "returnsLabel": {
        "shipiumShipmentId": "490b4ee3-147e-455b-aca7-a70456a58104",
        "carrierSelectionId": "c7ca006a-7c45-42df-a863-ffdca2225a93",
        "shipiumLabelId": "fdb3fa70-ddc7-4c27-abf0-29b8bb1e55eb",
        "documents": [
            {
                "labelExpiration": "2024-05-02T17:23:29.903Z",
                "labelFormat": "zpl",
                "labelProperties": {
                    "height": 6.0,
                    "width": 4.0,
                    "linearUnits": "in",
                    "dpi": 203,
                    "labelOrientation": "rotate_0"
                },
                "labelImage": {
                    "imageEncoding": "base64",
                    "imageContents": "Cl5YQQ0KXkxSTg0KXk1OWQ0KXk1GTixODQpeTEgxMCwxMg0KXk1DWQ0KXlBPSQ0KDQpeQ0kyNw0KXkZPMTUsN15BME4sMjAsMjReRlZKT0hOIERPRV5GUw0KXkZPMTUsMjdeQTBOLDIwLDI0XkZWMjA2MjY1MjczM15GUw0KXkZPMTUsNDdeQTBOLDIwLDI0XkZWSk9ITiBET0VeRlMNCl5GTzE1LDY3XkEwTiwyMCwyNF5GVjEwMCBNQUlOIFNULl5GUw0KXkZPMTUsODdeQTBOLDIwLDI0XkZWR0VSTUFOVE9XTiAgV0kgNTMwMjJeRlMNCl5GTzE1LDE0Ml5BME4sMjgsMzJeRlZTSElQIFRPOiBeRlMNCl5GTzYxLDE2Nl5BME4sMjgsMzJeRlZCSUxMIFNISVBQRVJeRlMNCl5GTzYxLDE5NF5BME4sMjgsMzJeRlYyMTIyMjIzNDM0XkZTDQpeRk82MSwyMjJeQTBOLDI4LDMyXkZWQklMTCBTSElQUEVSXkZTDQpeRk82MSwyNTFeQTBOLDI4LDMyXkZWMTIyMjQgQkVMLVJFRCBSRF5GUw0KXkZPNjEsMjc5XkEwTiw0NSw0NF5GVkJFTExFVlVFICBXQSAgOTgwMDVeRlMNCl5GTzQ0Niw5XkEwTiwzMCwzNF5GVjIgTEJTXkZTDQpeRk82ODMsOV5BME4sMjgsMzJeRlYxIE9GIDFeRlMNCl5GTzQwNiw0N15BME4sODAsNzBeRlZSU15GUw0KXkZPNTk5LDM2OV5BME4sNTYsNTheRlZTQU1QTEVeRlMNCl5GTzEwNiw0NTJeQTBOLDMwLDM0XkZWVVBTXkZTDQpeRk82NCw0ODJeQTBOLDMwLDM0XkZWTUFYSUNPREVeRlMNCl5GTzM4LDUxMl5BME4sMzAsMzReRlZQUklOVFMgSEVSRV5GUw0KXkZPMzAwLDQzNl5BME4sMzAsMzReRlZVUFMgUk9VVElORyBDT0RFIFBSSU5UUyBIRVJFXkZTDQpeRk8yNzAsNTI0XkEwTiwyOCwzMl5GVlVQUyBQT1NUQUwgQkFSQ09ERSBQUklOVFMgSEVSRV5GUw0KXkZPMTAsMTAzMV5BME4sMjIsMjZeRlZCSUxMSU5HOiBQL1BeRlMNCl5GTzEwLDEwNTNeQTBOLDIyLDI2XkZWREVTQzogY29udGVudERlc2NyaXB0aW9uXkZTDQpeRk8xMCwxMDc1XkEwTiwyMiwyNl5GVlJFVFVSTiBTRVJWSUNFXkZTDQpeRk80MTYsMTAzMV5BME4sNDQsMzZeRlZTQU1QTEVeRlMNCl5GTzEwLDExNjNeQTBOLDIyLDI2XkZWUmVmZXJlbmNlICMxOiBmZGIzZmE3MGRkYzc0YzI3YWJmMDI5YjhiYjFlNTVeRlMNCl5GTzE3NSwxMjAzXkEwTiwxNCwyMF5GVlhPTCAyNC4wNC4wNCAgICAgICAgICBOVjQ1IDE2LjBBIDA0LzIwMjQqXkZTDQpeRk85LDY3MF5BME4sNTYsNTheRlZVUFMgR1JPVU5EXkZTDQpeRk85LDczMV5BME4sMjQsMjheRlZUUkFDS0lORyAjOiBVUFMgVFJBQ0tJTkcgTlVNQkVSIFBSSU5UUyBIRVJFXkZTDQpeRk81OSw4NzNeQTBOLDMwLDM0XkZWVVBTIFRSQUNLSU5HIE5VTUJFUiBCQVJDT0RFIFBSSU5UUyBIRVJFXkZTDQpeRk82ODksNjUwXkdCMTI0LDEyNSwxMjQsQiwwXkZTDQpeRk8wLDY0OF5HQjgxMSwxNCwxNCxCLDBeRlMNCl5GTzAsNDIzXkdCODEyLDQsNCxCLDBeRlMNCl5GTzI0NCw0MjNeR0I0LDIyNSw0LEIsMF5GUw0KXkZPMCw3NzReR0I4MTIsNSw1LEIsMF5GUw0KXkZPMCwxMDEzXkdCODEyLDE0LDE0LEIsMF5GUw0KXkZPNjI5LDExNDcKXkdGQSwwMDk2OSwwMDk2OSwwMTksRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkYwMDAwMDAwMDANCkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGMDAwMDAwMDAwDQpGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRjAwMDAwMDAwMA0KRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkYwMDAwMDAwMDANCkYwMDAwMDAwMDAwMDAxRjgwMDAwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwMDAwMUY4MDAwMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMDNGODFGODNGQzAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDAzRjgxRjgzRkMwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwRkZGOUY5RkZGMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMEZGRjlGOUZGRjAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDBGRkZGRkZGRkZDMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwRkZGRkZGRkZGQzAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMEYwN0ZGRkYwRkMwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDBGMDdGRkZGMEZDMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwRkMxRkZGQzNGMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMEZDMUZGRkMzRjAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDBGRkZGRkZGRkYwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwRkZGRkZGRkZGMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMDNGRkZGRkZGQzAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDAzRkZGRkZGRkMwMDAwMDAwMDBGMDAwMDAwMDAwDQpGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRjAwMDAwMDAwMA0KRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkYwMDAwMDAwMDANCkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGMDAwMDAwMDAwDQpGMDAwMDAwMDAwMDFGRkZGRjAwMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMDAxRkZGRkYwMDAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDAwM0ZGRjlGQzAwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwMDNGRkY5RkMwMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMDNGRTFGODdGQzAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDAzRkUxRjg3RkMwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwRkY4MUY4M0ZGMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMEZGODFGODNGRjAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDBGRTAxRjgwM0YwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwRkUwMUY4MDNGMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMEYwMDFGODAwRjAwMDAwMDAwMEYwMDAwMDAwMDANCkYwMDAwMDAwMDBGMDAxRjgwMEYwMDAwMDAwMDBGMDAwMDAwMDAwDQpGMDAwMDAwMDAwMDAwMUY4MDAwMDAwMDAwMDAwRjAwMDAwMDAwMA0KRjAwMDAwMDAwMDAwMDFGODAwMDAwMDAwMDAwMEYwRkZEQzFDMDANCkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGMEZGREMxQzAwDQpGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRjAwQzFFM0MwMA0KRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkYwMEMxRTNDMDANCkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGMDBDMUEyQzAwDQpGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRjAwQzFCNkMwMA0KRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkYwMEMxQjZDMDANCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDBDMUI2QzAwDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwQzE5Q0MwMA0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMEMxOUNDMDANCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDBDMTlDQzAwDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwQzE4OEMwMA0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KXkRODQpeQ0YwLDE5MF5GTzQ3MCw5NTVeRkRYXkZTXlhaDQo="
                },
                "labelUrl": "https://shiptime-service.stage.shipium.com/api/v1/deliveryexperience/shipment/490b4ee3-147e-455b-aca7-a70456a58104/carrierSelection/c7ca006a-7c45-42df-a863-ffdca2225a93/label/fdb3fa70-ddc7-4c27-abf0-29b8bb1e55eb/zpl",
                "carrierTrackingId": null,
                "carrierTrackingLink": null,
                "packageReferenceIdentifier": null,
                "packageScannableId": null,
                "carrierShipmentId": null
            }
        ],
        "internationalDocuments": []
    },
    "ignoreUpgradeSpendLimits": false,
    "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
    "fulfillmentType": "customer",
    "packages": [
        {
            "packageReferenceIdentifier": null,
            "partnerProvidedPackageId": null,
            "orderItemQuantities": [
                {
                    "productId": "RN03947--Z43121",
                    "quantity": 3,
                    "productDetails": [],
                    "shipiumOrderId": "b0f7037a-2f37-4df8-b350-8ee1fb6eadec",
                    "hazmat": false
                },
            ],
            "packagingType": {
                "packagingMaterial": "box",
                "packagingSizeName": "5x5x5 Box",
                "packagingTypeId": null,
                "linearDimensions": {
                    "linearUnit": "in",
                    "length": 5,
                    "width": 5,
                    "height": 5
                },
                "packagingWeight": {
                    "weightUnit": "lb",
                    "weight": 2.0
                }
            },
            "totalWeight": {
                "weightUnit": "lb",
                "weight": 10.0
            },
            "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
    "orderItemQuantities": [
        {
            "productId": "RN03947--Z43121",
            "quantity": 3,
            "productDetails": [],
            "shipiumOrderId": "b0f7037a-2f37-4df8-b350-8ee1fb6eadec",
            "hazmat": false,
        },
    ],
    "destinationAddress": {
        "name": "Wile E. Coyote",
        "phoneNumber": "888-555-1234",
        "phoneNumberCountryCode": null,
        "emailAddress": "[email protected]",
        "company": "Buy It",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "state": "NM",
        "countryCode": "US",
        "postalCode": "87121",
        "addressType": "commercial"
    },
    "shipOption": "Standard",
    "shipFromAddress": {
        "name": "Ro Drunner",
        "phoneNumber": "5555555555",
        "phoneNumberCountryCode": null,
        "emailAddress": "[email protected]",
        "company": "Sell It",
        "street1": "401 Centre St.",
        "street2": null,
        "city": "Pottsville",
        "state": "PA",
        "countryCode": "US",
        "postalCode": "17901",
        "addressType": "commercial"
    },
    "fulfillmentCenterId": null,
    "fulfillmentContextId": "b4a3e646-4a10-4c7b-b974-1f115c9890c5",
    "requestFulfillmentContextIds": [
        "15daa625-aab7-4829-b224-3273bc89706d"
    ],
    "originId": "e8b5552c-7119-4f72-a611-e1fb42645a86",
    "packagingType": {
        "packagingMaterial": "box",
        "packagingSizeName": "5x5x5 Box",
        "packagingTypeId": null,
        "linearDimensions": {
            "linearUnit": "in",
            "length": 5,
            "width": 5,
            "height": 5
        },
        "packagingWeight": {
            "weightUnit": "lb",
            "weight": 2.0
        }
    },
    "totalWeight": {
        "weightUnit": "lb",
        "weight": 10.0
    },
    "shipmentTags": ["PSFC", "Returns"],
    "carrierSelection": {
        "status": "success",
        "statusDetails": "success",
        "carrierSelectionId": "843ad336-3ca3-4b76-9bfa-06d99d9dd519",
        "shipiumShipmentId": "ba1919a1-1c9a-4f53-93a7-8af49213be7c",
        "partnerShipmentId": "myCustomPartnerShipmentId123",
        "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
        "carrierAccountId": "625db658-e091-4e1b-888a-321270c8e6af",
        "serviceMethodUrn": null,
        "serviceMethodIdentifier": "15daa625-aab7-4829-b224-3273bc89706d:ZmVkZXgtaG9tZS1kZWxpdmVyeS1zZXJ2aWNlLW1ldGhvZDo6N2JiYjY5NzMtYWVkYi00YTcwLWFjMDctMjIwY2JiMzdjYjIwOjYyNWRiNjU4LWUwOTEtNGUxYi04ODhhLTMyMTI3MGM4ZTZhZjphOGVjYTRlYS1kMDcwLTRkZWMtOGZiMC0xNGNjMTQxMzJmNWQ6ZmVkZXg6ZThiNTU1MmMtNzExOS00ZjcyLWE2MTEtZTFmYjQyNjQ1YTg2Ojo",
        "carrier": "fedex",
        "carrierServiceMethodId": "fedex-home-delivery-service-method",
        "serviceMethodName": "FedEx Home Delivery",
        "totalCost": 4.2,
        "carrierCompareCost": 4.2,
        "carrierInvoiceCost": 4.2,
        "operationalCost": 4.2,
        "thirdPartyBilling": false,
        "carrierSelectionDateTime": "2019-10-30T17:23:28.722Z",
        "carrierZoneId": "fedex-zone-5"
    },
    "carrierLabel": {
        "shipiumShipmentId": "ba1919a1-1c9a-4f53-93a7-8af49213be7c",
        "partnerShipmentId": null,
        "carrierSelectionId": "843ad336-3ca3-4b76-9bfa-06d99d9dd519",
        "shipiumTenantId": null,
        "partnerTenantId": null,
        "shipiumLabelId": "c20e715e-4b42-4e9a-8621-33a97ed89516",
        "status": "success",
        "statusDetails": "success",
        "effectiveShipDateTime": "2019-10-31T17:23:28.68Z",
        "labelCreationDateTime": "2019-10-30T17:23:31.207Z",
        "serviceMethodIdentifier": "15daa625-aab7-4829-b224-3273bc89706d:ZmVkZXgtaG9tZS1kZWxpdmVyeS1zZXJ2aWNlLW1ldGhvZDo6N2JiYjY5NzMtYWVkYi00YTcwLWFjMDctMjIwY2JiMzdjYjIwOjYyNWRiNjU4LWUwOTEtNGUxYi04ODhhLTMyMTI3MGM4ZTZhZjphOGVjYTRlYS1kMDcwLTRkZWMtOGZiMC0xNGNjMTQxMzJmNWQ6ZmVkZXg6ZThiNTU1MmMtNzExOS00ZjcyLWE2MTEtZTFmYjQyNjQ1YTg2Ojo",
        "carrier": "fedex",
        "carrierServiceName": "FedEx Corporation Account - 2",
        "serviceMethodName": "FedEx Home Delivery",
        "carrierServiceMethodId": "fedex-home-delivery-service-method",
        "carrierShipmentId": "794624551550",
        "carrierTrackingId": "794624551550",
        "shipiumTrackingId": "52483a58-0788-4cf5-a2b4-b06610097158",
        "carrierTrackingLink": "https://wsbeta.fedex.com/fedextrack/?trknbr=794624551550",
        "carrierGroupId": null,
        "packageScannableId": null,
        "carrierLabelCurrencyCode": "USD",
        "carrierLabelPrice": 26.7,
        "billableWeight": {
            "weightUnit": "lb",
            "weight": 14.0
        },
        "documents": [
            {
                "labelExpiration": "2019-11-02T17:23:31.197106615Z",
                "labelFormat": "zpl",
                "labelProperties": {
                    "height": 6.0,
                    "width": 4.0,
                    "linearUnits": "in",
                    "dpi": 203,
                    "labelOrientation": "rotate_180"
                },
                "labelImage": {
                    "imageEncoding": "base64",
                    "imageContents": "XlhBXkNGLDAsMCwwXlBSMTJeTUQzMF5QT0leQ0kxM15MSDAsMjAKXkZPMTIsMTI0XkdCNzU1LDIsMl5GUwpeRk8xMiwzOTBeR0I3NzcsMiwyXkZTCl5GTzMyLDNeQWROLDAsMF5GV05eRkheRkRGUk9NOl5GUwpeRk8zMiwxOV5BZE4sMCwwXkZXTl5GSF5GRE1hYyBCcm93bl5GUwpeRk8zMiwzN15BZE4sMCwwXkZXTl5GSF5GREpHQyBTdG9yZF5GUwpeRk8zMiw1NV5BZE4sMCwwXkZXTl5GSF5GRDQyODUgQnVmb3JkIEh3eV5GUwpeRk8zMiw3M15BZE4sMCwwXkZXTl5GSF5GRF5GUwpeRk8zMiwxMDleQWROLDAsMF5GV05eRkheRkRVUyBeRlMKXkZPMjI0LDNeQWROLDAsMF5GV05eRkheRkQoMjE1KSA1NTUtNTU1NV5GUwpeRk8yOCw3NDJeQTBOLDI0LDI0XkZXTl5GSF5GRFRSSyNeRlMKXkZPMjgsODAwXkEwTiwyNywzMl5GV05eRkheRkReRlMKXkZPMTM2LDcxMl5BME4sMjcsMzZeRldOXkZIXkZEXkZTCl5GTzMyLDkxXkFkTiwwLDBeRldOXkZIXkZEQXRsYW50YSBHQSAzMDM0NV5GUwpeRk80NzgsM15BZE4sMCwwXkZXTl5GSF5GRFNISVAgREFURTogMThBUFIyNF5GUwpeRk80NzgsMTleQWROLDAsMF5GV05eRkheRkRBQ1RXR1Q6IDIuMDAgTEJeRlMKXkZPNDc4LDM3XkFkTiwwLDBeRldOXkZIXkZEQ0FEOiAwMDAwMDAwL1dTWEkzNjAwXkZTCl5GTzQ3OCw5MV5BZE4sMCwwXkZXTl5GSF5GREJJTEwgU0VOREVSXkZTCl5GTzM5LDEzNl5BME4sMzksMzleRldOXkZIXkZESm9obiBEb2VeRlMKXkZPMzksMTc4XkEwTiwzOSwzOV5GV05eRkheRkReRlMKXkZPMzksMjIwXkEwTiwzOSwzOV5GV05eRkheRkQxMDAgTWFpbiBTdC5eRlMKXkZPMzksMjYyXkEwTiwzOSwzOV5GV05eRkheRkQqKlRFU1QgTEFCRUwgLSBETyBOT1QgU0hJUCoqXkZTCl5GTzM5LDM0N15BZE4sMCwwXkZXTl5GSF5GRCgyMDYpIDI2NS0yNzMzXkZTCl5GTzM5LDMwNF5BME4sNDMsNDBeRldOXkZIXkZER2VybWFudG93biBXSSA1MzAyMl5GUwpeRk83MTksMzA0XkEwTiw0Myw0MF5GV05eRkheRkQoVVMpXkZTCl5GTzY3Nyw0NjJeR0IxMDQsMTAsMTBeRlMKXkZPNjc3LDQ3Ml5HQjEwLDExMiwxMF5GUwpeRk83NzEsNDcyXkdCMTAsMTEyLDEwXkZTCl5GTzY3Nyw1ODReR0IxMDQsMTAsMTBeRlMKXkZPNDY0LC0tXkdCMiwxMjYsMl5GUwpeRk82ODcsNDgwXkEwTiwxMjgsMTM3XkZXTl5GSF5GREheRlMKXkZPNjU0LDQwMl5BME4sNDMsNTheRldOXkZIXkZERmVkRXheRlMKXkZPNjYzLDQ0OF5BYk4sMTEsN15GV05eRkheRkRIb21lIERlbGl2ZXJ5XkZTCl5GTzc5MSw0OTNeQTBOLDEzLDE4XkZXQl5GSF5GREoyNDIwMjQwNDA0MDF1dl5GUwpeRk85LDEzNl5BME4sMjEsMjFeRldOXkZIXkZEVE9eRlMKXkZPMjEsNDEyXkJZMiwyXkI3TiwxMCw1LDE0XkZIXkZXTl5GSF5GRFspPl8xRTAxXzFEMDI1MzAyMl8xRDg0MF8xRDgwNF8xRDc5NDYyNDU1MTU1MF8xREZERUdfMUQ4MDAwMzAyXzFEMTA5XzFEXzFEMS8xXzFEMi4wMExCXzFETl8xRDEwMCBNYWluIFN0Ll8xREdlcm1hbnRvd25fMURXSV8xREpvaG4gRG9lXzFFMDZfMUQxMFpHSDAwN18xRDEyWjIwNjI2NTI3MzNfMUQyMFpfMUNfMUQzMVo5NjIyMDgwNDMwMDA4MDAwMzAyOTAwNzk0NjI0NTUxNTUwXzFEOUtjZWxpYS10ZXN0aW5nXzFEXzFFXzA0XkZTCl5GTzI4LDgzN15BME4sMTA3LDk2XkZXTl5GSF5GRF5GUwpeRk8xMiw2ODFeR0I3NzcsMiwyXkZTCl5GTzQ5NCw4ODVeQTBOLDQzLDQzXkZXTl5GSF5GRF5GUwpeRk83ODgsMjheQWJOLDExLDdeRldCXkZIXkZENTgzSjYvMEZFQy85QUUzXkZTCl5GTzk1LDc0Nl5BME4sNTMsNDBeRldOXkZIXkZEMDAwMCAwMDAwIDAwMDBeRlMKXkZPNDA5LDY5NV5BME4sNTEsMzheRldOXkZIXkZCMzkwLCwsUixeRkQgICAgICAgICAgICAgICAgICAgXkZTCl5GTzQwNCw3NDdeQTBOLDUxLDM4XkZXTl5GSF5GQjQwMCwsLFIsXkZEICAgICAgICAgICAgICAgICAgIF5GUwpeRk80MTMsNzk5XkEwTiw0MCw0MF5GV05eRkheRkIzODYsLCxSLF5GRCAgICAgICAgICAgICAgICBeRlMKXkZPNDk1LDg0MV5BME4sNDQsNDReRldOXkZIXkZCMjk4LCwsUixeRkQgICAgIDUzMDIyXkZTCl5GTzU3NCw5MDFeQTBOLDI0LDI0XkZXTl5GSF5GQjEyMCwsLFIsXkZEICAgICAgXkZTCl5GTzY5NSw4ODVeQTBOLDQzLDQzXkZXTl5GSF5GQjEwMCwsLFIsXkZEICAgXkZTCl5GTzM5LDkyN15BME4sMjcsMzZeRldOXkZIXkZEMDAwMCAwMDAwIDAgKDAwMCAwMDAgMDAwMCkgMCAwMCAwMDAwIDAwMDAgMDAwMF5GUwpeRk83NSw5NjheQlkzLDJeQkNOLDIwMCxOLE4sTixOXkZXTl5GRD47OTYyMjA4MDQzMDAwODAwMDMwMjkwMDAwMDAwMDAwMDAwMF5GUwpeRk8xMzUsMTAyOF5BME4sMTI4LDEzN15GV05eRkheRkRTQU1QTEVeRlMKXkZPNDc4LDU1XkFkTiwwLDBeRldOXkZIXkZERElNTUVEOiAyNCBYIDEwIFggOCBJTl5GUwpeRk8zMjksMzQ5XkFiTiwxMSw3XkZXTl5GSF5GRFJFRjogQ0VMSUEtVEVTVElOR15GUwpeRk8zOSwzNjNeQWJOLDExLDdeRldOXkZIXkZESU5WOiBeRlMKXkZPMzksMzc3XkFiTiwxMSw3XkZXTl5GSF5GRFBPOiBeRlMKXkZPNDI5LDM3N15BYk4sMTEsN15GV05eRkheRkRERVBUOiBeRlMKXlBRMQpeWFoK"
                },
                "labelUrl": "https://shiptime-service.stage.shipium.com/api/v1/deliveryexperience/shipment/ba1919a1-1c9a-4f53-93a7-8af49213be7c/carrierSelection/843ad336-3ca3-4b76-9bfa-06d99d9dd519/label/c20e715e-4b42-4e9a-8621-33a97ed89516/zpl",
                "carrierTrackingId": null,
                "carrierTrackingLink": null,
                "packageReferenceIdentifier": null,
                "packageScannableId": null,
                "carrierShipmentId": null
            }
        ],
            },
        "customerReturnCreateParams": null,
        "labelCreateParams": {
                "currencyCode": "usd",
                "labelFormats": [
                    "zpl"
                ],
                "manifest": "true",
                "includeLabelImagesInResponse": "true",
                "customLabelEntries": {},
                "testMode": "true",
                "contentDescription": "general merchandise"
            },
                "labelCostLineItems": [
                {
                    "name": "Residential delivery surcharge",
                    "currencyCode": "USD",
                    "cost": 5.55
                },
                {
                    "name": "FedEx Ground Fuel",
                    "currencyCode": "USD",
                    "cost": 1.4
                },
                {
                    "name": "Base Charge",
                    "currencyCode": "USD",
                    "cost": 19.75
                }
            ],
            "carrierLabelAugmentations": [],
            "shipiumManifestId": null,
            "carrierManifestId": null,
            "manifestDetails": {
                "success": true,
                "interactionType": "manifest",
                "requestToCarrier": null,
                "errorStatusCode": null,
                "errorMessage": null,
                "responseFromCarrier": null,
                "exceptionDetails": null,
                "sequenceNumber": null,
                "errorType": null,
                "retryable": false
            },
            "manifestRequestParams": null,
            "labelVoidDetails": null,
            "originalLabelImageFromTheCarrier": {
                "imageEncoding": "base64",
                "imageContents": "XlhBXkNGLDAsMCwwXlBSMTJeTUQzMF5QVzgwMF5QT0leQ0kxM15MSDAsMjAKXkZPMTIsMTI0XkdCNzU1LDIsMl5GUwpeRk8xMiwzOTBeR0I3NzcsMiwyXkZTCl5GTzMyLDNeQWROLDAsMF5GV05eRkheRkRGUk9NOl5GUwpeRk8zMiwxOV5BZE4sMCwwXkZXTl5GSF5GRE1hYyBCcm93bl5GUwpeRk8zMiwzN15BZE4sMCwwXkZXTl5GSF5GREpHQyBTdG9yZF5GUwpeRk8zMiw1NV5BZE4sMCwwXkZXTl5GSF5GRDQyODUgQnVmb3JkIEh3eV5GUwpeRk8zMiw3M15BZE4sMCwwXkZXTl5GSF5GRF5GUwpeRk8zMiwxMDleQWROLDAsMF5GV05eRkheRkRVUyBeRlMKXkZPMjI0LDNeQWROLDAsMF5GV05eRkheRkQoMjE1KSA1NTUtNTU1NV5GUwpeRk8yOCw3NDJeQTBOLDI0LDI0XkZXTl5GSF5GRFRSSyNeRlMKXkZPMjgsODAwXkEwTiwyNywzMl5GV05eRkheRkReRlMKXkZPMTM2LDcxMl5BME4sMjcsMzZeRldOXkZIXkZEXkZTCl5GTzMyLDkxXkFkTiwwLDBeRldOXkZIXkZEQXRsYW50YSBHQSAzMDM0NV5GUwpeRk80NzgsM15BZE4sMCwwXkZXTl5GSF5GRFNISVAgREFURTogMThBUFIyNF5GUwpeRk80NzgsMTleQWROLDAsMF5GV05eRkheRkRBQ1RXR1Q6IDIuMDAgTEJeRlMKXkZPNDc4LDM3XkFkTiwwLDBeRldOXkZIXkZEQ0FEOiAwMDAwMDAwL1dTWEkzNjAwXkZTCl5GTzQ3OCw5MV5BZE4sMCwwXkZXTl5GSF5GREJJTEwgU0VOREVSXkZTCl5GTzM5LDEzNl5BME4sMzksMzleRldOXkZIXkZESm9obiBEb2VeRlMKXkZPMzksMTc4XkEwTiwzOSwzOV5GV05eRkheRkReRlMKXkZPMzksMjIwXkEwTiwzOSwzOV5GV05eRkheRkQxMDAgTWFpbiBTdC5eRlMKXkZPMzksMjYyXkEwTiwzOSwzOV5GV05eRkheRkQqKlRFU1QgTEFCRUwgLSBETyBOT1QgU0hJUCoqXkZTCl5GTzM5LDM0N15BZE4sMCwwXkZXTl5GSF5GRCgyMDYpIDI2NS0yNzMzXkZTCl5GTzM5LDMwNF5BME4sNDMsNDBeRldOXkZIXkZER2VybWFudG93biBXSSA1MzAyMl5GUwpeRk83MTksMzA0XkEwTiw0Myw0MF5GV05eRkheRkQoVVMpXkZTCl5GTzY3Nyw0NjJeR0IxMDQsMTAsMTBeRlMKXkZPNjc3LDQ3Ml5HQjEwLDExMiwxMF5GUwpeRk83NzEsNDcyXkdCMTAsMTEyLDEwXkZTCl5GTzY3Nyw1ODReR0IxMDQsMTAsMTBeRlMKXkZPNDY0LC0tXkdCMiwxMjYsMl5GUwpeRk82ODcsNDgwXkEwTiwxMjgsMTM3XkZXTl5GSF5GREheRlMKXkZPNjU0LDQwMl5BME4sNDMsNTheRldOXkZIXkZERmVkRXheRlMKXkZPNjYzLDQ0OF5BYk4sMTEsN15GV05eRkheRkRIb21lIERlbGl2ZXJ5XkZTCl5GTzc5MSw0OTNeQTBOLDEzLDE4XkZXQl5GSF5GREoyNDIwMjQwNDA0MDF1dl5GUwpeRk85LDEzNl5BME4sMjEsMjFeRldOXkZIXkZEVE9eRlMKXkZPMjEsNDEyXkJZMiwyXkI3TiwxMCw1LDE0XkZIXkZXTl5GSF5GRFspPl8xRTAxXzFEMDI1MzAyMl8xRDg0MF8xRDgwNF8xRDc5NDYyNDU1MTU1MF8xREZERUdfMUQ4MDAwMzAyXzFEMTA5XzFEXzFEMS8xXzFEMi4wMExCXzFETl8xRDEwMCBNYWluIFN0Ll8xREdlcm1hbnRvd25fMURXSV8xREpvaG4gRG9lXzFFMDZfMUQxMFpHSDAwN18xRDEyWjIwNjI2NTI3MzNfMUQyMFpfMUNfMUQzMVo5NjIyMDgwNDMwMDA4MDAwMzAyOTAwNzk0NjI0NTUxNTUwXzFEOUtjZWxpYS10ZXN0aW5nXzFEXzFFXzA0XkZTCl5GTzI4LDgzN15BME4sMTA3LDk2XkZXTl5GSF5GRF5GUwpeRk8xMiw2ODFeR0I3NzcsMiwyXkZTCl5GTzQ5NCw4ODVeQTBOLDQzLDQzXkZXTl5GSF5GRF5GUwpeRk83ODgsMjheQWJOLDExLDdeRldCXkZIXkZENTgzSjYvMEZFQy85QUUzXkZTCl5GTzk1LDc0Nl5BME4sNTMsNDBeRldOXkZIXkZEMDAwMCAwMDAwIDAwMDBeRlMKXkZPNDA5LDY5NV5BME4sNTEsMzheRldOXkZIXkZCMzkwLCwsUixeRkQgICAgICAgICAgICAgICAgICAgXkZTCl5GTzQwNCw3NDdeQTBOLDUxLDM4XkZXTl5GSF5GQjQwMCwsLFIsXkZEICAgICAgICAgICAgICAgICAgIF5GUwpeRk80MTMsNzk5XkEwTiw0MCw0MF5GV05eRkheRkIzODYsLCxSLF5GRCAgICAgICAgICAgICAgICBeRlMKXkZPNDk1LDg0MV5BME4sNDQsNDReRldOXkZIXkZCMjk4LCwsUixeRkQgICAgIDUzMDIyXkZTCl5GTzU3NCw5MDFeQTBOLDI0LDI0XkZXTl5GSF5GQjEyMCwsLFIsXkZEICAgICAgXkZTCl5GTzY5NSw4ODVeQTBOLDQzLDQzXkZXTl5GSF5GQjEwMCwsLFIsXkZEICAgXkZTCl5GTzM5LDkyN15BME4sMjcsMzZeRldOXkZIXkZEMDAwMCAwMDAwIDAgKDAwMCAwMDAgMDAwMCkgMCAwMCAwMDAwIDAwMDAgMDAwMF5GUwpeRk83NSw5NjheQlkzLDJeQkNOLDIwMCxOLE4sTixOXkZXTl5GRD47OTYyMjA4MDQzMDAwODAwMDMwMjkwMDAwMDAwMDAwMDAwMF5GUwpeRk8xMzUsMTAyOF5BME4sMTI4LDEzN15GV05eRkheRkRTQU1QTEVeRlMKXkZPNDc4LDU1XkFkTiwwLDBeRldOXkZIXkZERElNTUVEOiAyNCBYIDEwIFggOCBJTl5GUwpeRk8zMjksMzQ5XkFiTiwxMSw3XkZXTl5GSF5GRFJFRjogQ0VMSUEtVEVTVElOR15GUwpeRk8zOSwzNjNeQWJOLDExLDdeRldOXkZIXkZESU5WOiBeRlMKXkZPMzksMzc3XkFiTiwxMSw3XkZXTl5GSF5GRFBPOiBeRlMKXkZPNDI5LDM3N15BYk4sMTEsN15GV05eRkheRkRERVBUOiBeRlMKXlBRMQpeWFoK"
            },
            "limitIncrementCountSuccess": null,
            "shipiumTrackingId": null,
          
    "customsInfo": null,
    "saturdayDelivery": false,
    "deliverySignatureOption": "None",
    "deliveryWindow": null,
    "deliveryNote": null,
    "forceThirdPartyBilling": false,
    "referenceIdentifier": "PSFC-2478",
    "referenceIdentifier2": null,
    "referenceIdentifier3": null,
    "referenceIdentifier4": null,
    "referenceIdentifier5": null,
    "purchaseOrderIdentifier": null,
    "fulfillmentContext": null,
    "createdWithVersion": "v2",
    "details": {
        "carrierSelection": null,
        "fulfillmentContextDetailsSearch": {
            "country": "US",
            "fulfillmentType": "customer",
            "postalCode": "17901",
            "tenantId": null,
            "thirdPartyBillingAccountSetId": null,
            "tag": null,
            "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
            "includeSimulation": false,
            "fulfillmentContextIds": [
                "15daa625-aab7-4829-b224-3273bc89706d"
            ]
            },
            "createUsingExistingShipment": null,
            "generateLabel": true,
            "includeEvaluatedServiceMethodsInResponse": false,
            "labelParameters": {
                "currencyCode": "usd",
                "labelFormats": [
                    "zpl"
                ],
                "manifest": true,
                "includeLabelImagesInResponse": true,
                "customLabelEntries": {},
                "testMode": true,
                "contentDescription": "general merchandise"
            },
            "asOfDate": null,
            "carrierServiceMethodAllowList": [],
            "includeInjectionProfiles": false,
            "injectionParameters": [],
            "simulation": false,
            "simulationParameters": null,
            "inlineReturnsLabel": {
                "partnerShipmentId": "myCustomPartnerShipmentId123",
                "returnToAddress": {
                    "countryCode": "US",
                    "postalCode": "17901",
                    "addressType": "commercial",
                    "city": "Pottsville",
                    "company": "Sell It",
                    "emailAddress": "[email protected]",
                    "name": "Ro Drunner",
                    "phoneNumber": "5555555555",
                    "state": "PA",
                    "street1": "401 Centre St.",
                    "street2": null
                },
                "returnToContactInfo": {
                    "contactName": "Ro Drunner",
                    "phoneNumber": "5555555555",
                    "phoneNumberCountryCode": "1",
                    "email": "[email protected]"
               	},
                "fulfillmentContextId": "b4a3e646-4a10-4c7b-b974-1f115c9890c5"
    },
            "returnsContentDescription": "general merchandise"
        },
}

Generate a return label independent of shipment label generation

The carrier return label API is very closely related to the carrier and method selection and carrier shipment label APIs, so you will find that many of the structures and components overlap with those. Required and optional fields are defined in the table for the previous example.

Example cURL request

The request looks very similar to a carrier shipment label request. You pass information about the origin address and destination address, as shown in the cURL request below:

curl --request POST \
     --url <<api_url>>/api/v1/deliveryexperience/customerreturn/label
     --header 'accept: application/json' \
     --header $AUTHSTRING \
     --header 'content-type: application/json' \
     --data 'INSERT REQUEST BODY FROM BELOW'

Example request body

The following example includes partnerReturnRequestId, customLabelEntries, and orderItemQuantities. All these are optional and can be omitted. You can find more details about custom label entries in Label Customization. The table describing request fields in the section above and the Return Label API Reference provide details about information to include in the API request.

{
    "currencyCode": "usd",
    "generateLabel": True,
    "labelParameters": {
        "testMode": True,
        "currencyCode": "usd",
        "labelFormats": [
            "zpl"
        ],
        "manifest": True,
        "includeLabelImagesInResponse": True,
        "contentDescription": "General Merchandise",
        "customLabelEntries": {
            "order-number": "CUSTOM_ORDER_NUMBER"
        }
    },
    "destinationAddress": {
        "addressType": "commercial",
        "company": "Shipium Warehouse",
        "name": "Attn: RETURNS",
        "street1": "1234 Warehouse Way",
        "street2": "Suite 101",
        "city": "Reno",
        "state": "NV",
        "postalCode": "89521",
        "countryCode": "US"
    },
    "originAddress": {
        "addressType": "residential",
        "name": "Wile E. Coyote",
        "company": "ACME",
        "street1": "123 Warehouse St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "state": "NM",
        "postalCode": "87121",
        "countryCode": "US"
    },
    "packagingType": {
        "packagingMaterial": "box",
        "packagingSizeName": "5x5x5 Box",
        "packagingTypeId": null,
        "linearDimensions": {
            "linearUnit": "in",
            "length": 5,
            "width": 5,
            "height": 5
            },
        "packagingWeight": {
            "weightUnit": "lb",
            "weight": 2.0
            },
    "orderItemQuantities": [
        {
            "productId": "MM-01-001",
            "quantity": 1
        },
        {
            "productId": "GR-08-001",
            "quantity": 1,
            "productDetails": [
                "ormd"
            ]
        }
    ],
    "customerReturnParams": {
        "partnerReturnRequestId": "customReturnRequestId",
        "returnRequestDateTime": "2021-01-11T00:00:00+00:00",
        "contentDescription": "General Merchandise"
    }
}

Example response body

The return label response is almost identical to the response returned by carrier shipment label, though with some differences as carrier costing does not occur for return labels.

{
    "carrier": "ups",
    "carrierServiceName": "UPS Returns Service",
    "carrierShipmentId": "1Z204E380338943508",
    "carrierTrackingId": "1Z204E380338943508",
    "shipiumTrackingId": "52483a58-0788-4cf5-a2b4-b06610097158",
    "documents": [
        {
            "labelExpiration": "2020-11-19T21:11:42.628Z",
            "labelFormat": "ZPL",
            "labelImage": {
                "imageEncoding": "base64",
                "imageContents": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAIKADAAQAAAABAAAAIAAAAACPTkDJAAACJElEQVRYCe1Vz0sbURCe2XWbiNZKRaxgEipIKYVSqFR7SuJRCipSDz1JD1Io4j/goe2l9xYPxYu9FLoRz/aUaCmUYKFee4hiKSg0ovVHY0x2nCe85e3GmM2Kl3bf5c3Mm/fN976ZZQGCFSgQKPC/K4AXEeDu6qemP9uHRi2M9eTITrUcXwS6l+Z7SmSZRHCvGrAzjnnQ6PnP+NhHZxxAcwe8+MdkvfFeXCBSGxLMda+Y19z4De6A8GPp1DQBdLVfvTm5s5eLFRFeslStMhcRZwHxrfTV3SJ6B0RdakzYTDhMh3CLzax6VkFAsDzeh1d8A3/v595zoUdsP2FC9tLDV56u9Q9t2QHFiKbNAzVXOQIq6xWKVxDI9Y7tRjOpKS7c+SBO2W9f6JdVQn492QpQoTgYWzKPVHBpM+8W8Vyvy9cQ8is3uUSH1yIyTwf94Xpy9Kv0xe6Q5AWRw1cTL8u2FYik53tZ5kVEWNhIPJ6IZFIz7D8DcpIURBoaQzfUGYh+Nu9TCVZqkTxXAUTrNhdsI6B+AYRAibOK1ypS77k9hH1x+JBd1vIhw1oVIHo4NEB/i0nSKttSKhRfRzJmSBajMlyXdr273YJ6Ll7aEHomwf3xnKskol62FPfU9DX1/JmftskNdp7Pw12gsvHDneOLgKFpkwz43Q1W3cc8IYyf9Vf0NQOy0J202XwAhj3IMu7e1xLDu/z/8NU2N1bgBwoECvx7CpwAEhquciKZh7kAAAAASUVORK5CYII="
            },
            "labelProperties": {
              "dpi": 203,
              "height": 6,
              "labelOrientation": "rotate_0",
              "linearUnits": "in",
              "width": 4
            },
            "labelUrl": "https://api.shipium.com/labels/1a486afc-2ffc-4c37-928f-8d6aa014b35b.zpl"
        }
    ],
    "params": {
        "partnerReturnRequestId": "customReturnRequestId",
        "returnRequestDateTime": "2021-01-11T00:00:00+00:00",
        "contentDescription": "General Merchandise"
    },
   "packagingType": {
        "packagingMaterial": "box",
        "packagingSizeName": "5x5x5 Box",
        "packagingTypeId": null,
        "linearDimensions": {
            "linearUnit": "in",
            "length": 5,
            "width": 5,
            "height": 5
            },
        "packagingWeight": {
            "weightUnit": "lb",
            "weight": 2.0
            },
    "serviceMethodName": "UPS Returns Service",
    "shipiumCustomerReturnLabelId": "4c6af31c-6f1d-4b20-a16f-a9110135e442",
    "status": "success",
    "statusDetails": "string"
}

Retrieve previously created labels

You can retrieve previously created labels by calling the same API endpoint you used to generate the label, using the GET request type and passing the returnLabelId you previously received in your response body.

Here's the cURL example call for retrieving a return label. You'll replace the returnLabelId value with the one you received during label generation.

curl --request GET \
     --url  <<api_url>/api/v1/deliveryexperience/customerreturn/label/{returnLabelId}
     --header 'accept: application/json' \
     --header $AUTHSTRING \
     --header 'content-type: application/json'

πŸ“˜

More information on the API responses

As with all Shipium API responses, this API follows the API Response Codes standards unless otherwise specified.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful: