---
updatedAt: 2026-06-11T22:02:16.000Z
agentTools:
  projectIndex: https://docs.shipium.com/llms.txt
---

# Retrieve a previously generated returns label.  This call is the metadata about the label, the images of the labels must be asked for specifically in the call, or directly using the `getReturnsLabelImageV1` call.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipium API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.shipium.com",
      "description": "Generated server url"
    }
  ],
  "security": [
    {
      "oauth2Scheme": [
        "delivery-experience-service"
      ]
    }
  ],
  "paths": {
    "/api/v1/deliveryexperience/customerreturn/label/{shipiumCustomerReturnLabelId}": {
      "get": {
        "tags": [
          "return-label-generation"
        ],
        "summary": "Retrieve a previously generated returns label.  This call is the metadata about the label, the images of the labels must be asked for specifically in the call, or directly using the `getReturnsLabelImageV1` call.",
        "operationId": "returnsGetLabelV1",
        "parameters": [
          {
            "name": "shipiumCustomerReturnLabelId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeLabelImagesInResponse",
            "in": "query",
            "required": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Label previously generated for the return.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerReturnLabel"
                }
              }
            }
          },
          "404": {
            "description": "Unable to find return Label",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerReturnLabel"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AddressLineComponents": {
        "type": "object",
        "properties": {
          "streetName": {
            "type": "string",
            "description": "The name of the street.",
            "example": "U.H. Fovisste Fuentes Brotantes"
          },
          "primaryAddressNumber": {
            "type": "string",
            "description": "The primary, or external, address number.",
            "example": "12"
          },
          "secondaryAddressNumber": {
            "type": "string",
            "description": "The secondary, or internal, address number.",
            "example": "302"
          },
          "district": {
            "type": "string",
            "description": "The district, or municipality, for the address.",
            "example": "Iztacalco"
          },
          "neighborhood": {
            "type": "string",
            "description": "The neighborhood for the address.",
            "example": "Agrícola Pantitlán"
          }
        },
        "description": "The components extracted from street1 and street2"
      },
      "CSAddress": {
        "required": [
          "countryCode",
          "postalCode"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name associated with the address.",
            "example": "Wile E. Coyote"
          },
          "phoneNumber": {
            "type": "string",
            "description": "Phone number of the contact."
          },
          "phoneNumberCountryCode": {
            "type": "string",
            "description": "Phone Number Country Code of the contact.",
            "example": "+2"
          },
          "emailAddress": {
            "type": "string",
            "description": "Email address of the contact."
          },
          "company": {
            "type": "string",
            "description": "The company name for the address.",
            "example": "ACME"
          },
          "street1": {
            "type": "string",
            "description": "The first address line.",
            "example": "123 Main St."
          },
          "street2": {
            "type": "string",
            "description": "The second address line.",
            "example": "Suite 42"
          },
          "city": {
            "type": "string",
            "description": "The name of the city for the address.",
            "example": "Albuquerque"
          },
          "state": {
            "type": "string",
            "description": "The name of the state for the address.",
            "example": "NM"
          },
          "countryCode": {
            "type": "string",
            "description": "The ISO 3166-1 country code for the address.",
            "example": "US"
          },
          "postalCode": {
            "type": "string",
            "description": "A countryCode-appropriate postal code for the address.",
            "example": "\"87121\""
          },
          "addressType": {
            "type": "string",
            "description": "The type of location for this address.",
            "example": "commercial",
            "enum": [
              "commercial",
              "residential"
            ]
          },
          "addressLineComponents": {
            "$ref": "#/components/schemas/AddressLineComponents"
          }
        },
        "description": "Address details of the sold to party for customs purposes"
      },
      "Broker": {
        "type": "object",
        "properties": {
          "brokerAddress": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "accountNumber": {
            "type": "string",
            "description": "Account Number of the broker"
          },
          "taxIdentificationNumbers": {
            "type": "array",
            "description": "Tax Identification numbers of broker",
            "items": {
              "$ref": "#/components/schemas/RequestTaxIdentificationNumber"
            }
          },
          "deliveryInstructions": {
            "type": "string",
            "description": "Delivery Instructions of broker"
          },
          "type": {
            "type": "string",
            "description": "Type of the broker",
            "enum": [
              "IMPORT",
              "EXPORT"
            ]
          }
        },
        "description": "Address details of the broker for customs purposes"
      },
      "CarrierLabelImage": {
        "type": "object",
        "properties": {
          "imageEncoding": {
            "type": "string",
            "description": "Format in which the \"imageContents\" field is encoded e.g. base64."
          },
          "imageContents": {
            "type": "string",
            "description": "Raw contents of the shipment label image encoded in Base64.  End users will need to decode this data using the format information supplied in the \"labelInfo\" field."
          },
          "imageFormat": {
            "type": "string",
            "description": "Image format e.g. jpeg, png. Only populated for printerless labels."
          }
        },
        "description": "Base64 encoded ZPL as generated by the carrier before label sanitation and augmentations are performed."
      },
      "CarrierLabelInfo": {
        "type": "object",
        "properties": {
          "labelExpiration": {
            "type": "string",
            "description": "Date time when the label expires and is no longer valid.",
            "format": "date-time"
          },
          "labelFormat": {
            "type": "string",
            "description": "Defines the format the shipment label was generated in by the carrier."
          },
          "labelProperties": {
            "$ref": "#/components/schemas/ShiptimeLabelProperties"
          },
          "labelImage": {
            "$ref": "#/components/schemas/CarrierLabelImage"
          },
          "labelUrl": {
            "type": "string",
            "description": "Url with is the link to the shipment label file on the Shipium CDN."
          },
          "carrierTrackingId": {
            "type": "string",
            "description": "The tracking id associated with this label."
          },
          "carrierTrackingLink": {
            "type": "string",
            "description": "The tracking link associated with this label."
          },
          "packageReferenceIdentifier": {
            "type": "string",
            "description": "The package reference id that was passed in by the customer to be associated with this package.Most frequently used for multi parcel shipments.  This can be used to cross reference internation documents and carrier labels."
          },
          "shipiumPackageReferenceId": {
            "type": "string",
            "description": "The package reference Identifier created by shipium."
          },
          "packageScannableId": {
            "type": "string",
            "description": "The package scannable id associated with this label."
          },
          "carrierShipmentId": {
            "type": "string",
            "description": "The carrier shipment id associated with the label."
          },
          "printerlessInfo": {
            "$ref": "#/components/schemas/PrinterlessInfo"
          }
        },
        "description": "List of links to labels generated by format for the shipment."
      },
      "CpscCertificateOfCompliance": {
        "required": [
          "filingMode"
        ],
        "type": "object",
        "properties": {
          "filingMode": {
            "type": "string",
            "description": "CPSC Certificate of Compliance filing mode",
            "enum": [
              "FULL",
              "REFERENCE"
            ]
          },
          "cpscProductId": {
            "type": "string",
            "description": "CPSC product certification identifier — distinct from the SKU-level productId on CustomsItem or OrderItemQuantity (required for FULL mode)"
          },
          "applicableCpscRules": {
            "type": "array",
            "description": "CPSC rules or standards the product was tested against (required for FULL mode, e.g. \"16 CFR 1219\", \"ASTM F2194\")",
            "items": {
              "type": "string",
              "description": "CPSC rules or standards the product was tested against (required for FULL mode, e.g. \"16 CFR 1219\", \"ASTM F2194\")"
            }
          },
          "dateOfManufacture": {
            "type": "string",
            "description": "Date the product was manufactured (required for FULL mode)",
            "format": "date"
          },
          "manufacturerName": {
            "type": "string",
            "description": "Name of the manufacturer (required for FULL mode)"
          },
          "manufacturerAddress": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "lastComplianceTestingDate": {
            "type": "string",
            "description": "Date of most recent compliance testing (required for FULL mode)",
            "format": "date"
          },
          "testingLabName": {
            "type": "string",
            "description": "Name of the accredited testing laboratory (required for FULL mode)"
          },
          "testingLabAddress": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "testingLabContactInfo": {
            "type": "string",
            "description": "Testing laboratory phone or email contact (required for FULL mode)"
          },
          "importerRecordKeeperContact": {
            "type": "string",
            "description": "Importer or record-keeper contact information (required for FULL mode)"
          },
          "registryProductId": {
            "type": "string",
            "description": "Product ID in the CPSC Product Registry (required for REFERENCE mode)"
          },
          "registryVersionId": {
            "type": "string",
            "description": "Version ID in the CPSC Product Registry (required for REFERENCE mode)"
          },
          "registryCertifierId": {
            "type": "string",
            "description": "Certifier ID in the CPSC Product Registry (required for REFERENCE mode)"
          }
        },
        "description": "CPSC Certificate of Compliance data for US import of CPSC-regulated consumer products. Supports two filing modes: FULL (all certificate data inline) or REFERENCE (pointer to CPSC Product Registry)."
      },
      "CustomerReturnParams": {
        "required": [
          "contentDescription"
        ],
        "type": "object",
        "properties": {
          "partnerReturnRequestId": {
            "type": "string",
            "description": "Partner provided identification for this return.  Must be alphanumeric and 30 chars wide."
          },
          "fulfillmentContext": {
            "type": "string",
            "description": "When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext"
          },
          "returnRequestDateTime": {
            "type": "string",
            "description": "ISO-8601 formatted date of the return request, if not set will use the current date time.",
            "format": "date-time"
          },
          "contentDescription": {
            "type": "string",
            "description": "A short description (under 35 characters) of the package contents being returned that is passed on to the carrier."
          },
          "customsInfo": {
            "$ref": "#/components/schemas/RequestCustomsInfo"
          },
          "saturdayDelivery": {
            "type": "boolean",
            "description": "Indicates that this return shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday"
          },
          "returnPaymentType": {
            "type": "string",
            "description": "Whether this return label is prepaid (billed when the label is created) or pay_on_use (billed only when the customer actually ships it back). Not present, null, and empty all behave as today: carriers that support pay-on-use keep minting pay-on-use, everyone else is unaffected. Only USPS Direct honors this today.",
            "enum": [
              "prepaid",
              "pay_on_use"
            ]
          }
        },
        "description": "Details of the customer return required for label generation by the carriers."
      },
      "CustomsItemData": {
        "type": "object",
        "properties": {
          "customsValue": {
            "type": "number",
            "description": "The value of each individual item to report to customs in customsValueCurrency",
            "format": "float",
            "example": 12.34
          },
          "customsValueCurrency": {
            "type": "string",
            "description": "The ISO-4217 currency code representing the customsValue",
            "example": "usd"
          },
          "commodityDescription": {
            "minLength": 3,
            "type": "string",
            "description": "A description of this product to be provided to customs",
            "example": "baby socks"
          },
          "countryOfManufacture": {
            "type": "string",
            "description": "The ISO-3166 2 digit country code that manufactured the this product",
            "example": "CN"
          },
          "customsWeight": {
            "$ref": "#/components/schemas/Weight"
          },
          "quantity": {
            "type": "integer",
            "description": "The number of units of this customs item",
            "format": "int32",
            "example": 3
          },
          "productId": {
            "type": "string",
            "description": "The merchant's product identifier (SKU) for this customs item.",
            "example": "RN03947--Z43121"
          },
          "standardizedProductIds": {
            "type": "array",
            "description": "Standardized product identifiers (GTIN/EAN/UPC/ISBN) for this customs item.",
            "items": {
              "$ref": "#/components/schemas/StandardizedProductId"
            }
          },
          "manufacturerProductId": {
            "type": "string",
            "description": "The manufacturer's non-standardised product identifier (EU C128) for this customs item — a free-form code assigned by the manufacturer or brand (e.g. internal SKU / part number). Distinct from the merchant productId and the standardized barcodes.",
            "example": "MPN-77B-XL"
          },
          "quantityUnitOfMeasurement": {
            "type": "string",
            "description": "The unit of measurement of the item",
            "enum": [
              "bag",
              "barrel",
              "box",
              "case_of_goods",
              "container",
              "crate",
              "cylinder",
              "envelope",
              "pallet",
              "piece",
              "roll",
              "tube",
              "unknown"
            ]
          },
          "harmonizedTariffNumber": {
            "type": "string",
            "description": "The 6-15 digit Harmonized System Tariff classification code for the ORIGIN country's export declaration — for example an 8-digit EU or a US Schedule B code. Where the destination requires a different code, supply importHarmonizedTariffNumber as well.",
            "example": "6402918005"
          },
          "importHarmonizedTariffNumber": {
            "type": "string",
            "description": "The classification code for the DESTINATION country's import entry — for example a 10-digit HTSUS code into the US, or a 10-digit TARIC code into the EU. Optional, and independent of harmonizedTariffNumber.",
            "example": "6402918005"
          },
          "commodityPartNumber": {
            "type": "string",
            "description": "The part number or reference number for the product"
          },
          "marksAndNumbers": {
            "type": "string",
            "description": "Any special marks, codes, and numbers that may identify the package"
          },
          "electronicExportCommodityInformation": {
            "$ref": "#/components/schemas/ElectronicExportCommodityInformation"
          },
          "b13AFilingOption": {
            "type": "string",
            "description": "Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any  country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands.",
            "enum": [
              "NOT_REQUIRED",
              "MANUALLY_ATTACHED",
              "FILED_ELECTRONICALLY",
              "SUMMARY_REPORTING",
              "CARRIER_TO_STAMP",
              "UNKNOWN"
            ]
          },
          "exportComplianceStatement": {
            "type": "string",
            "description": "For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654 Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label. For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A."
          },
          "cpscCertificateOfCompliance": {
            "$ref": "#/components/schemas/CpscCertificateOfCompliance"
          }
        },
        "description": "Contains customs information for each item in the shipment."
      },
      "DocumentImage": {
        "type": "object",
        "properties": {
          "documentEncoding": {
            "type": "string",
            "description": "Format in which the \"documentContents\" field is encoded",
            "example": "base64"
          },
          "documentContents": {
            "type": "string",
            "description": "Raw contents of the encoded document.  End users will need to decode this data using the format information supplied in the \"documentEncoding\" field."
          }
        },
        "description": "The generated document image contents and encoding."
      },
      "ElectronicExportCommodityInformation": {
        "required": [
          "eccnNumber",
          "exportInformationCode",
          "exportLicenseInformation",
          "exportType",
          "scheduleBInformation"
        ],
        "type": "object",
        "properties": {
          "exportType": {
            "type": "string",
            "description": "The type of the export.",
            "example": "domestic",
            "enum": [
              "domestic",
              "foreign",
              "unknown"
            ]
          },
          "exportInformationCode": {
            "type": "string",
            "description": "The 2-digit export information code for the commodity.",
            "example": "LC"
          },
          "scheduleBInformation": {
            "$ref": "#/components/schemas/ScheduleBInformation"
          },
          "eccnNumber": {
            "type": "string",
            "description": "The 5-digit product ECCN number as issued by the Bureau of Industry and Security. The format is #A###.",
            "example": "EAR99"
          },
          "exportLicenseInformation": {
            "$ref": "#/components/schemas/ExportLicenseInformation"
          }
        },
        "description": "Customs item information that is particular to the Electronic Export Information (EEI)"
      },
      "ElectronicExportInformation": {
        "type": "object",
        "properties": {
          "exportDate": {
            "type": "string",
            "description": "The date the goods will be exiting the country",
            "format": "date"
          },
          "pointOfOrigin": {
            "type": "string",
            "description": "The 2-character state abbreviation from which the goods were shipped to the port of export."
          }
        },
        "description": "Information for the Electronic Export Information (EEI) customs form, only used when the EEI will be filed directly by the carrier (i.e. not filed by the partner using AES Direct or otherwise)"
      },
      "EuropeanUnionInfo": {
        "type": "object",
        "properties": {
          "vendorIossNumber": {
            "type": "string",
            "description": "An Import One-Stop-Shop (IOSS) number is a 12-digit identification number that is used to pay VAT and declare imports to the European Union (EU). The IOSS number is a type of VAT identification, but it is not the same as a resident VAT registration."
          },
          "vendorIossAddress": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "windsorFramework": {
            "$ref": "#/components/schemas/WindsorFrameworkInfo"
          }
        },
        "description": "Important information to supply when shipping to the european union."
      },
      "ExportLicense": {
        "required": [
          "licenseExpiration",
          "licenseLineValue",
          "licenseNumber"
        ],
        "type": "object",
        "properties": {
          "licenseNumber": {
            "type": "string",
            "description": "The license number."
          },
          "licenseLineValue": {
            "type": "integer",
            "description": "The export monetary amount allowed per license.",
            "format": "int32"
          },
          "licenseExpiration": {
            "type": "string",
            "description": "The license expiration date.",
            "format": "date"
          }
        },
        "description": "The export license, if the license type requires a valid license."
      },
      "ExportLicenseInformation": {
        "required": [
          "licenseType"
        ],
        "type": "object",
        "properties": {
          "licenseType": {
            "type": "string",
            "description": "The standard license type code as published by the US government.",
            "example": "C33"
          },
          "licenseExemptionCode": {
            "type": "string",
            "description": "The license exemption code, if the license type does not require a license number.",
            "example": "NLR"
          },
          "exportLicense": {
            "$ref": "#/components/schemas/ExportLicense"
          }
        },
        "description": "The license information for the export."
      },
      "ExportReturnInfo": {
        "type": "object",
        "properties": {
          "originalExportDate": {
            "type": "string",
            "description": "The date the goods were originally exported on the outbound shipment.",
            "format": "date",
            "example": "2026-08-19"
          },
          "originalExportTrackingId": {
            "type": "string",
            "description": "The tracking number of the original outbound shipment the goods were exported on.",
            "example": "2647515076"
          },
          "originalOutboundCarrier": {
            "type": "string",
            "description": "The carrier that carried the original outbound shipment.",
            "example": "DHL EXPRESS"
          }
        },
        "description": "Details of the original outbound shipment that this return is sent back against. Supplied once for the shipment; each field is independently optional."
      },
      "HazardousMaterialsDocumentInfo": {
        "type": "object",
        "properties": {
          "documentType": {
            "type": "string",
            "description": "The type of international document. For 'multiple', there will be multiple types of forms",
            "example": "OP_900LG",
            "enum": [
              "OP_900LG",
              "OP_900LL"
            ]
          },
          "documentExpiration": {
            "type": "string",
            "description": "Date time when the document expires and is no longer valid.",
            "format": "date-time"
          },
          "documentFormat": {
            "type": "string",
            "description": "Defines the format the document was generated in by the carrier."
          },
          "documentImage": {
            "$ref": "#/components/schemas/DocumentImage"
          },
          "electronicallySubmitted": {
            "type": "boolean",
            "description": "Indication of whether or not this international document has been electronically submitted by the carrier",
            "example": true
          },
          "packageReferenceIdentifier": {
            "type": "string",
            "description": "The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments.  This can be used to cross reference internation documents and labels."
          }
        },
        "description": "List of hazardous materials documents generated by the carrier for the shipment."
      },
      "ImporterOfRecord": {
        "type": "object",
        "properties": {
          "importerAddress": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "accountNumber": {
            "type": "string",
            "description": "Account Number of importer"
          },
          "taxIdentificationNumbers": {
            "type": "array",
            "description": "Tax Identification numbers of importer",
            "items": {
              "$ref": "#/components/schemas/RequestTaxIdentificationNumber"
            }
          }
        },
        "description": "Address details of the importer for customs purposes for the vast majority of Express import shipments"
      },
      "InternationalDocumentInfo": {
        "type": "object",
        "properties": {
          "documentType": {
            "type": "string",
            "description": "The type of international document. For 'multiple', there will be multiple types of forms",
            "example": "commercial_invoice",
            "enum": [
              "commercial_invoice",
              "electronic_export_information",
              "ps_2976",
              "air_waybill",
              "multiple",
              "unknown"
            ]
          },
          "documentExpiration": {
            "type": "string",
            "description": "Date time when the document expires and is no longer valid.",
            "format": "date-time"
          },
          "documentFormat": {
            "type": "string",
            "description": "Defines the format the document was generated in by the carrier."
          },
          "documentImage": {
            "$ref": "#/components/schemas/DocumentImage"
          },
          "electronicallySubmitted": {
            "type": "boolean",
            "description": "Indication of whether or not this international document has been electronically submitted by the carrier",
            "example": true
          },
          "packageReferenceIdentifier": {
            "type": "string",
            "description": "The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments.  This can be used to cross reference internation documents and labels."
          }
        },
        "description": "List of international customs documents generated by the carrier for the shipment."
      },
      "InvoicePrePaidAmount": {
        "type": "object",
        "properties": {
          "value": {
            "type": "number",
            "description": "The prepaid amount value.",
            "format": "float"
          },
          "currencyCode": {
            "type": "string",
            "description": "The currency code for the prepaid amount."
          }
        },
        "description": "Prepaid shipping/handling charges to include on the commercial invoice."
      },
      "PrinterlessInfo": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of printerless label. Examples: qrcode, barcode, nfc, rfid."
          },
          "valueRepresented": {
            "type": "string",
            "description": "The value embedded in the QR code or barcode. This is typically a public URL or tracking identifier."
          }
        },
        "description": "Printerless label information. Only present when labelFormat is 'printerless'."
      },
      "RequestCustomsInfo": {
        "type": "object",
        "properties": {
          "totalCustomsValue": {
            "type": "number",
            "description": "The customs value of the shipment in totalCustomsValueCurrency",
            "format": "float",
            "example": 12.34
          },
          "totalCustomsValueCurrency": {
            "type": "string",
            "description": "The ISO-4217 currency code representing the totalCustomsValue",
            "example": "usd"
          },
          "customsDescription": {
            "type": "string",
            "description": "The detailed description of the items being shipped",
            "example": "9 mm steel screws"
          },
          "reasonForExport": {
            "type": "string",
            "description": "The reason to export an international shipment",
            "example": "sale",
            "enum": [
              "sale",
              "gift",
              "sample",
              "returns",
              "personal_effects",
              "unknown"
            ]
          },
          "businessIndicator": {
            "type": "string",
            "description": "Shipment-level indicator of whether the shipment is a business-to-consumer (B2C) or business-to-business (B2B) transaction. Required for EU27-inbound customs clearance after the 2026-07-01 de minimis removal. Partner-supplied; not derived from the address type.",
            "example": "B2C",
            "enum": [
              "B2C",
              "B2B",
              "unknown"
            ]
          },
          "invoiceDate": {
            "type": "string",
            "description": "Date when the invoice was created. Ideally this is the same as the ship date",
            "format": "date",
            "example": "1970-01-01"
          },
          "invoiceNumber": {
            "type": "string",
            "description": "The Commercial Invoice number, if the Commercial Invoice was generated by the partner",
            "example": "abcde-f12345-67890-abcdef"
          },
          "invoicePrePaidAmount": {
            "$ref": "#/components/schemas/InvoicePrePaidAmount"
          },
          "europeanUnionInfo": {
            "$ref": "#/components/schemas/EuropeanUnionInfo"
          },
          "exportReturnInfo": {
            "$ref": "#/components/schemas/ExportReturnInfo"
          },
          "ultimateConsigneeAddress": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "ultimateConsigneeType": {
            "type": "string",
            "description": "The type of the ultimate consignee",
            "example": "direct_consumer",
            "enum": [
              "direct_consumer",
              "government_entity",
              "reseller",
              "unknown"
            ]
          },
          "aesInternalTransactionNumber": {
            "type": "string",
            "description": "The number received if the Electronic Export Information (EEI) was filed and has been accepted in the Automated Export System (AES)"
          },
          "electronicExportInformation": {
            "$ref": "#/components/schemas/ElectronicExportInformation"
          },
          "b13AFilingOption": {
            "type": "string",
            "description": "Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any  country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands.",
            "enum": [
              "NOT_REQUIRED",
              "MANUALLY_ATTACHED",
              "FILED_ELECTRONICALLY",
              "SUMMARY_REPORTING",
              "CARRIER_TO_STAMP",
              "UNKNOWN"
            ]
          },
          "exportComplianceStatement": {
            "type": "string",
            "description": "For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654 Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label. For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A."
          },
          "permitNumber": {
            "type": "string",
            "description": "This is a Permit Number. This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed.",
            "example": "12345"
          },
          "customsItems": {
            "type": "array",
            "description": "Contains customs information for each item in the shipment.",
            "items": {
              "$ref": "#/components/schemas/CustomsItemData"
            }
          },
          "incoterm": {
            "type": "string",
            "description": "Enum used to represent desired incoterm.",
            "example": "DDP",
            "enum": [
              "DDP",
              "DDU",
              "DAP",
              "DPU",
              "FCA",
              "CPT",
              "FOB",
              "EXW"
            ]
          },
          "declarationStatement": {
            "type": "string",
            "description": "A customs declaration statement for the shipment that, if provided, will appear on generated commercial invoices."
          },
          "taxIdentificationNumber": {
            "type": "string",
            "description": "The EIN tax identification number of the shipper",
            "example": "12345"
          },
          "importerOfRecord": {
            "$ref": "#/components/schemas/ImporterOfRecord"
          },
          "brokers": {
            "type": "array",
            "description": "Address details of the broker for customs purposes",
            "items": {
              "$ref": "#/components/schemas/Broker"
            }
          },
          "soldTo": {
            "$ref": "#/components/schemas/SoldTo"
          }
        },
        "description": "Customs information about the package for international shipping."
      },
      "RequestTaxIdentificationNumber": {
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "Tax Identification Number",
            "example": "12345"
          },
          "tinType": {
            "type": "string",
            "description": "Type of Tax Identification Number",
            "enum": [
              "PERSONAL_NATIONAL",
              "PERSONAL_STATE",
              "FEDERAL",
              "BUSINESS_NATIONAL",
              "BUSINESS_STATE",
              "BUSINESS_UNION"
            ]
          }
        },
        "description": "Tax Identification numbers of the sold to party"
      },
      "ScheduleBInformation": {
        "required": [
          "scheduleBNumber",
          "scheduleBQuantity",
          "scheduleBUnitOfMeasurement"
        ],
        "type": "object",
        "properties": {
          "scheduleBNumber": {
            "type": "string",
            "description": "The 10-digit Schedule B classification code for the item being exported",
            "example": "6404195500"
          },
          "scheduleBQuantity": {
            "type": "integer",
            "description": "The count of how many Schedule B units are in the shipment",
            "format": "int32"
          },
          "scheduleBUnitOfMeasurement": {
            "type": "string",
            "description": "The unit of measure for the Schedule B quantity",
            "enum": [
              "barrels",
              "carat",
              "content_kilogram",
              "square_centimeter",
              "content_ton",
              "curie",
              "clean_yield_kilogram",
              "dozen",
              "dozen_pieces",
              "dozen_pairs",
              "fiber_meter",
              "gross_container",
              "gram",
              "gross",
              "hundred",
              "kilogram",
              "cubic_kilometer",
              "kilogram_total_sugars",
              "liter",
              "meter",
              "square_meter",
              "cubic_meter",
              "millicurie",
              "number",
              "pieces",
              "proof_liter",
              "pack",
              "pairs",
              "running_bales",
              "square",
              "ton",
              "thousand",
              "no_quantity_required",
              "unknown"
            ]
          }
        },
        "description": "The Schedule B information for the commodity."
      },
      "ShiptimeLabelDimensions": {
        "type": "object",
        "properties": {
          "height": {
            "type": "number",
            "description": "Top to bottom measurement of the label in linearUnits, required if width is present",
            "format": "float"
          },
          "width": {
            "type": "number",
            "description": "Right to left measurement of the label in linearUnits, required if height is present",
            "format": "float"
          },
          "linearUnits": {
            "type": "string",
            "description": "The linear units representing the label height and width. If this is present, both the height and width are required in the LabelDimensions. If this is missing, the linearUnits from LabelProperties will be used."
          }
        },
        "description": "The dimensions used to print non-ZPL labels, if they need to be different than ZPL dimensions"
      },
      "ShiptimeLabelProperties": {
        "required": [
          "dpi",
          "height",
          "labelOrientation",
          "linearUnits",
          "width"
        ],
        "type": "object",
        "properties": {
          "height": {
            "type": "number",
            "description": "Top to bottom measurement of the label in linearUnits",
            "format": "float"
          },
          "width": {
            "type": "number",
            "description": "Right to left measurement of the label in linearUnits",
            "format": "float"
          },
          "linearUnits": {
            "type": "string",
            "description": "The linear units representing the labelHeight and labelWidth"
          },
          "dpi": {
            "type": "integer",
            "description": "The dpi (Dots Per Inch) used by the label printer",
            "format": "int32"
          },
          "labelOrientation": {
            "type": "string",
            "description": "The direction that the label will be printed"
          },
          "nonZplLabelDimensions": {
            "$ref": "#/components/schemas/ShiptimeLabelDimensions"
          }
        },
        "description": "Metadata describing the label."
      },
      "SoldTo": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/CSAddress"
          },
          "accountNumber": {
            "type": "string",
            "description": "Account Number of the sold to party"
          },
          "taxIdentificationNumbers": {
            "type": "array",
            "description": "Tax Identification numbers of the sold to party",
            "items": {
              "$ref": "#/components/schemas/RequestTaxIdentificationNumber"
            }
          }
        },
        "description": "Address details of the sold to party for customs purposes"
      },
      "StandardizedProductId": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The standard that a standardized product identifier conforms to (e.g. a barcode standard).",
            "example": "GTIN",
            "enum": [
              "GTIN",
              "EAN",
              "UPC",
              "ISBN",
              "unknown"
            ]
          },
          "value": {
            "type": "string",
            "description": "The standardized product identifier value.",
            "example": "0012345678905"
          }
        },
        "description": "Standardized product identifiers (GTIN/EAN/UPC/ISBN) for this customs item."
      },
      "Weight": {
        "type": "object",
        "properties": {
          "weightUnit": {
            "type": "string",
            "description": "The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds",
            "example": "lb",
            "enum": [
              "g",
              "kg",
              "oz",
              "lb"
            ]
          },
          "weight": {
            "type": "number",
            "description": "The value of the weight.",
            "format": "float",
            "example": 50
          }
        },
        "description": "The weight of this type of packaging empty."
      },
      "WindsorFrameworkInfo": {
        "type": "object",
        "properties": {
          "atRisk": {
            "type": "boolean",
            "description": "UK Windsor Framework \"at risk\" declaration for GB→Northern Ireland shipments. true = the goods are at risk of onward movement into the EU (red lane, full customs + duty); false = not at risk (green lane, UKIMS-backed). GB→NI only."
          }
        },
        "description": "UK Windsor Framework declaration for GB→Northern Ireland shipments."
      },
      "CustomerReturnLabel": {
        "type": "object",
        "properties": {
          "shipiumShipmentId": {
            "type": "string",
            "description": "The unique identifier for the shipment attached to this label."
          },
          "carrierSelectionId": {
            "type": "string",
            "description": "Unique id of the carrier selection for later lookup."
          },
          "shipiumCustomerReturnLabelId": {
            "type": "string",
            "description": "The unique identifier for this customer return."
          },
          "status": {
            "type": "string",
            "description": "Defines the result of the carrier label call.  Values returned will be success, partial, and failed",
            "enum": [
              "success",
              "failure",
              "voided",
              "failover",
              "generated",
              "imported",
              "label_created",
              "manifesting",
              "manifested",
              "manifest_failure",
              "not_set",
              "carrier_selection_failure"
            ]
          },
          "statusDetails": {
            "type": "string",
            "description": "Details explaining the result status.  Pertinent when the status is \"partial\" or \"failed\"."
          },
          "carrier": {
            "type": "string",
            "description": "The carrier that was used for the return."
          },
          "carrierServiceName": {
            "type": "string",
            "description": "Name of the carrier service method selected."
          },
          "serviceMethodName": {
            "type": "string",
            "description": "Name of the service method the label was generated for."
          },
          "carrierServiceMethodId": {
            "type": "string",
            "description": "Maps to the unique internal Shipium ID which represents a carrier service method definition."
          },
          "carrierShipmentId": {
            "type": "string",
            "description": "Carrier's identification for the return."
          },
          "carrierTrackingId": {
            "type": "string",
            "description": "Carrier's tracking identification for the return."
          },
          "shipiumTrackingId": {
            "type": "string",
            "description": "Shipium's tracking identification for the return."
          },
          "packageScannableId": {
            "type": "string",
            "description": "Identifier provided that matches the scannable barcode on the label"
          },
          "params": {
            "$ref": "#/components/schemas/CustomerReturnParams"
          },
          "documents": {
            "type": "array",
            "description": "List of links to labels generated by format for the return.",
            "items": {
              "$ref": "#/components/schemas/CarrierLabelInfo"
            }
          },
          "internationalDocuments": {
            "type": "array",
            "description": "List of international customs documents generated by the carrier for the shipment.",
            "items": {
              "$ref": "#/components/schemas/InternationalDocumentInfo"
            }
          },
          "hazardousMaterialsDocuments": {
            "type": "array",
            "description": "List of hazmat documents generated by the carrier for the shipment.",
            "items": {
              "$ref": "#/components/schemas/HazardousMaterialsDocumentInfo"
            }
          },
          "referenceIdentifier": {
            "type": "string",
            "description": "String passed to carriers as a reference."
          },
          "referenceIdentifier2": {
            "type": "string",
            "description": "String passed to carriers as a reference2."
          },
          "referenceIdentifier3": {
            "type": "string",
            "description": "String passed to carriers as a reference3."
          },
          "referenceIdentifier4": {
            "type": "string",
            "description": "String passed to carriers as a reference4."
          },
          "referenceIdentifier5": {
            "type": "string",
            "description": "String passed to carriers as a reference5."
          },
          "partnerReferenceIdentifier": {
            "type": "string",
            "description": "Partner custom reference to a return label."
          },
          "partnerReferenceIdentifier2": {
            "type": "string",
            "description": "Partner custom reference to a return label."
          },
          "testMode": {
            "type": "boolean",
            "description": "A flag denoting whether the label is a test label"
          },
          "labelCreationDateTime": {
            "type": "string",
            "description": "The timestamp that the label object was created.  This is used primarily for explaining future dated shipments.",
            "format": "date-time"
          }
        }
      }
    },
    "securitySchemes": {
      "oauth2Scheme": {
        "type": "oauth2",
        "flows": {
          "password": {
            "tokenUrl": "https://auth.shipium.com/oauth/token",
            "scopes": {
              "delivery-experience-service": "Access to the Shipium API"
            }
          }
        }
      }
    }
  }
}
```