SHshipium
pack-ship-orchestration

Pack and ship order.

Changed on
post/api/v1/packShip/order/{orderId}/submit

Request

Path parameters

orderIdstring required

The Shipium-generated order ID (shipiumOrderId) or the partner-provided order ID (partnerOrderId). When using the partnerOrderId, only orders in a non-cancelled state will match. Orders that have been cancelled will not be found by their partnerOrderId.

Query parameters

tenantIdstring

Submits order to print label having tenantId passed in.

Request body

generateLabelboolean

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.

splitOrderboolean

When true, this is a signal that the order submit will execute a split shipment. It is expected that either the splitReferenceId is set pointing to pre-defined split in the referenced order order.orderFulfillmentParameters.splitParameters[splitReferenceId], or a ad hoc runtime is defined in this object at: splitParameters

splitReferenceIdstring

When splitOrder is true, this field is used to reference a pre-existing split in the order referenced by this split at order.orderFulfillmentParameters.splitParameters[splitReferenceId]. Note that if both this field and splitParameters are set this field will be used to execute the split.

Example request

{
  "packagingType": {
    "packagingMaterial": "box",
    "packagingSizeName": "13x12x10 Box",
    "packagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 13,
      "width": 12,
      "height": 10
    },
    "packagingWeight": {
      "weightUnit": "lb",
      "weight": 50
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 50
  },
  "inlineReturnsLabel": {
    "partnerShipmentId": "myCustomPartnerShipmentId123",
    "returnToAddress": {
      "name": "Wile E. Coyote",
      "phoneNumberCountryCode": "+2",
      "company": "ACME",
      "street1": "123 Main St.",
      "street2": "Suite 42",
      "city": "Albuquerque",
      "state": "NM",
      "countryCode": "US",
      "postalCode": "\"87121\"",
      "addressType": "commercial",
      "addressLineComponents": {
        "streetName": "U.H. Fovisste Fuentes Brotantes",
        "primaryAddressNumber": "12",
        "secondaryAddressNumber": "302",
        "district": "Iztacalco",
        "neighborhood": "Agrícola Pantitlán"
      }
    }
  },
  "shipmentParameters": {
    "partnerShipmentId": "myCustomPartnerShipmentId123",
    "shippedDateTime": "2019-10-29T09:12:33.123456Z",
    "desiredDeliveryDate": "2019-10-31T20:00:00Z",
    "preferredCarrierDeliveryDateTime": "2019-10-31T20:00:00Z",
    "businessDaysOfTransit": 3,
    "returnToAddress": {
      "name": "Wile E. Coyote",
      "phoneNumberCountryCode": "+2",
      "company": "ACME",
      "street1": "123 Main St.",
      "street2": "Suite 42",
      "city": "Albuquerque",
      "state": "NM",
      "countryCode": "US",
      "postalCode": "\"87121\"",
      "addressType": "commercial",
      "addressLineComponents": {
        "streetName": "U.H. Fovisste Fuentes Brotantes",
        "primaryAddressNumber": "12",
        "secondaryAddressNumber": "302",
        "district": "Iztacalco",
        "neighborhood": "Agrícola Pantitlán"
      }
    },
    "deliverySignatureOption": "ResidentSignature",
    "lastMileDeliveryOptions": {
      "tip": {
        "type": "FIXED"
      },
      "tipForLabelCreate": {
        "type": "FIXED"
      }
    },
    "pickupWindow": {
      "startWindow": "10:15:30",
      "endWindow": "10:15:30"
    },
    "deliveryWindow": {
      "startWindow": "10:15:30",
      "endWindow": "10:15:30"
    },
    "payorAccounts": [
      {
        "payorAccountAddress": {
          "name": "Wile E. Coyote",
          "phoneNumberCountryCode": "+2",
          "company": "ACME",
          "street1": "123 Main St.",
          "street2": "Suite 42",
          "city": "Albuquerque",
          "state": "NM",
          "countryCode": "US",
          "postalCode": "\"87121\"",
          "addressType": "commercial",
          "addressLineComponents": {
            "streetName": "U.H. Fovisste Fuentes Brotantes",
            "primaryAddressNumber": "12",
            "secondaryAddressNumber": "302",
            "district": "Iztacalco",
            "neighborhood": "Agrícola Pantitlán"
          }
        }
      }
    ]
  },
  "splitParameters": {
    "orderItemQuantities": [
      {
        "orderItemReferenceIdentifier": "someIdentifier",
        "productId": "RN03947--Z43121",
        "quantity": 3
      }
    ]
  }
}

Response

The results of the order submission.

shipiumShipmentIdstring required

The unique identifier for this shipment.

partnerShipmentIdstring

The optional unique identifier that may be used for this shipment.

shipiumBulkProcessingIdsstring[]

The Shipium-generated unique identifiers for the bulk (or LTL) shipments that this is part of. This list is ordered from the most recent bulk shipment to the least recent.

orderedDateTimestring date-time

The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp.

shippedDateTimestring date-time

The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse. The timestamp must be a valid ISO 8601 timestamp.

rawDesiredDeliveryDatestring

The timestamp passed in by you (or your fulfillment partner) for the intended date the package will arrive to the customer. The timestamp must be a valid ISO 8601 timestamp.

preferredCarrierDeliveryDateTimestring date-time

The string representation of either an ISO-8601 date. The datetime the package is intended to arrive to the customer. This will be passed through to the carrier.

businessDaysOfTransitinteger

Indicates the number of business days from the ship time by when the shipment needs to be delivered.

originTimezoneIdstring
destinationTimezoneIdstring
ignoreUpgradeSpendLimitsboolean

Indicates that this shipment can ignore all the partner-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date.

deliveredDateTimestring date-time

The timestamp for when the package was delivered to the customer. The timestamp must be a valid ISO 8601 timestamp.

cancellationDateTimestring date-time

The timestamp for when a shipment is cancelled. This field will default to null when the shipment is not cancelled. A shipment cannot be cancelled if it is associated with an label

fulfillmentType'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown'

Fulfillment methodology of the shipment.

carrierNamestring

The carrier that was used for delivering the package to your customer.

carrierTrackingIdstring

Carrier's tracking identification for the package.

shipOptionstring

A high-level shipping option shown to or selected by a customer.

fulfillmentCenterIdstring

The Shipium identifier for the fulfillment center where the shipment will depart.

fulfillmentContextIdstring

The Shipium identifier for the fulfillment context where the shipment will depart.

partnerFulfillmentContextIdstring

The partner alias for the fulfillment context where the shipment will depart.

requestFulfillmentContextIdsstring[]

A collection of fulfillmentContextIds or fulfillmentContext aliases used in the FulfillmentContextDetail search.

shipmentTagsstring[]

A collection of free-form tags that may be added to this shipment.

saturdayDeliveryboolean

Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday

desktopDeliveryboolean

Indicates that this shipment is a desktop delivery. Defaults to false.

deliverySignatureOption'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown'

Defaults to None

deliveryNotestring

String passed to carriers for a delivery note.

requestThirdPartyBillingSetIdstring

Either the shipium third party billing set ID or the partner provided third party billing set ID. When present, this is the third party billing set ID sent on the request.

shipiumThirdPartyBillingSetIdstring

The shipium generated third party billing set ID. When present, this is used to indicate the third party billing set ID associated with the shipment.

partnerThirdPartyBillingSetIdstring

The partner provided third party billing set ID. When present, this is used to indicate the third party billing set ID associated with the shipment.

forceThirdPartyBillingboolean

Indicates that third party billing is forced for this shipment

referenceIdentifierstring

String passed to carriers as a reference.

referenceIdentifier2string

String passed to carriers as a reference2.

referenceIdentifier3string

String passed to carriers as a reference3.

referenceIdentifier4string

String passed to carriers as a reference4.

referenceIdentifier5string

String passed to carriers as a reference5.

packageReferenceIdentifierstring

Used to correlate parcels to label documents from the carrier.

purchaseOrderIdentifierstring

String passed to carriers as a purchase order identifier.

partnerReferenceIdentifierstring

Partner supplied string as a reference (not passed to carriers).

partnerReferenceIdentifier2string

Partner supplied string as a reference2 (not passed to carriers).

carrierProcessingIdstring

Carrier-provided identifier, supplied when it is needed to process the shipment.

fulfillmentContextstring

When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext

requestTenantIdstring

Either the shipium tenant ID or the partner provided tenant ID. When present, this is the tenant Id sent on the request.

shipiumTenantIdstring

The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the shipment.

partnerTenantIdstring

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

createdWithVersion'v1' | 'v2'

The version used when creating the shipment.

shipmentPropertiesstring[]

A list of high-level properties about the shipment

testModeboolean

Indicates a testMode shipment. Carrier selection will consider carriers and service methods in test mode and label generation will generate a test label.

orderSourceNamestring

Field that is used to determine source of order. This field may be utilized to inform carrier of the source of the order for handling.

endorsementType'AddressServiceRequested' | 'ForwardingServiceRequested' | 'ChangeServiceRequested' | 'ReturnServiceRequested' | 'CarrierLeaveIfNoResponse'

AddressServiceRequested, ForwardingServiceRequested, ChangeServiceRequested, ReturnServiceRequested, CarrierLeaveIfNoResponse

useShipFromAddressInRequestboolean

Describes whether or not to use the shipFromAddress in the request (instead of the address which is configured on the origin.

desiredDeliveryDateLocalstring

A ISO-8601 date-time without a time-zone

multiParcelboolean
estimatedDeliveryDateLocalstring

A ISO-8601 date-time without a time-zone

missingRequiredLabelFieldsstring[]
desiredDeliveryDatestring date-time

The timestamp for the adjusted desired delivery date. This date includes all adjustments that Shipium has made to the requested desired delivery date. Shipium will use this dateTime for carrier selection. The timestamp must be a valid ISO 8601 timestamp.

effectiveShipDateTimestring date-time

Shipium's calculation for the effective ship date time that a shipment will ship out.

estimatedDeliveryDatestring date-time

The date and time by when the package is estimated to be delivered to the customer.

Example response

{
  "shipiumShipmentId": "0840c7a2-e6ab-4755-8aa2-9a986297ad6d",
  "partnerShipmentId": "myCustomPartnerShipmentId123",
  "shipiumBulkProcessingIds": [
    "2364c106-ae48-4680-b044-dc1eb20c310a"
  ],
  "orderIds": [
    {
      "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
      "partnerOrderId": "myCustomPartnerOrderId123"
    }
  ],
  "orderedDateTime": "2019-10-29T09:12:33.123456Z",
  "shippedDateTime": "2019-10-29T09:12:33.123456Z",
  "rawDesiredDeliveryDate": "2019-10-31T10:50:11.123456Z",
  "preferredCarrierDeliveryDateTime": "2019-10-31T20:00:00Z",
  "returnsLabel": {
    "internationalDocuments": [
      {
        "documentType": "commercial_invoice",
        "documentImage": {
          "documentEncoding": "base64"
        },
        "electronicallySubmitted": true
      }
    ],
    "hazardousMaterialsDocuments": [
      {
        "documentType": "OP_900LG",
        "documentImage": {
          "documentEncoding": "base64"
        },
        "electronicallySubmitted": true
      }
    ]
  },
  "customerForwardLabels": [
    {
      "partnerShipmentId": "myCustomPartnerShipmentId123",
      "internationalDocuments": [
        {
          "documentType": "commercial_invoice",
          "documentImage": {
            "documentEncoding": "base64"
          },
          "electronicallySubmitted": true
        }
      ],
      "hazardousMaterialsDocuments": [
        {
          "documentType": "OP_900LG",
          "documentImage": {
            "documentEncoding": "base64"
          },
          "electronicallySubmitted": true
        }
      ]
    }
  ],
  "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
  "cancellationDateTime": "2019-10-31T10:50:11.123456Z",
  "carrierName": "UPS",
  "carrierTrackingId": "1Z999AA10123456784",
  "packages": [
    {
      "orderItemQuantities": [
        {
          "orderItemReferenceIdentifier": "someIdentifier",
          "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
          "partnerOrderId": "myCustomPartnerOrderId123",
          "hazmatInfo": {
            "category": "defined",
            "quantity": 2.1,
            "quantityType": "gross",
            "quantityUnits": "l",
            "containerType": "aluminum_jerrican",
            "hazmatId": "UN1755",
            "properShippingName": "Chromic Acid Solution",
            "packingGroup": "II",
            "transportMode": "passenger_and_cargo_aircraft",
            "packingInstructionCode": "967",
            "hazardClass": "class_8_corrosive_material",
            "subsidiaryClasses": [
              "8.1"
            ],
            "numberOfInnerPackagings": 2,
            "innerPackagingType": "glass bottle",
            "outerPackagingType": "fiberboard box",
            "shipperDeclarationStatement": "LQ_air",
            "wattHours": 100,
            "lithiumContent": 1.5,
            "numberOfCells": 4,
            "numberOfBatteries": 2,
            "batteryConfiguration": "packed_with_equipment"
          },
          "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
          "productId": "RN03947--Z43121",
          "quantity": 3,
          "itemWeight": {
            "weightUnit": "lb",
            "weight": 50
          }
        }
      ],
      "packagingType": {
        "packagingMaterial": "box",
        "packagingSizeName": "13x12x10 Box",
        "shipiumPackagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
        "partnerPackagingTypeId": "rno-packaging-1",
        "requestPackagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
        "linearDimensions": {
          "linearUnit": "in",
          "length": 13,
          "width": 12,
          "height": 10
        },
        "packagingWeight": {
          "weightUnit": "lb",
          "weight": 50
        }
      },
      "totalWeight": {
        "weightUnit": "lb",
        "weight": 50
      },
      "deliveredDateTime": "2019-10-31T10:50:11.123456Z"
    }
  ],
  "orderItemQuantities": [
    {
      "orderItemReferenceIdentifier": "someIdentifier",
      "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
      "partnerOrderId": "myCustomPartnerOrderId123",
      "hazmatInfo": {
        "category": "defined",
        "quantity": 2.1,
        "quantityType": "gross",
        "quantityUnits": "l",
        "containerType": "aluminum_jerrican",
        "hazmatId": "UN1755",
        "properShippingName": "Chromic Acid Solution",
        "packingGroup": "II",
        "transportMode": "passenger_and_cargo_aircraft",
        "packingInstructionCode": "967",
        "hazardClass": "class_8_corrosive_material",
        "subsidiaryClasses": [
          "8.1"
        ],
        "numberOfInnerPackagings": 2,
        "innerPackagingType": "glass bottle",
        "outerPackagingType": "fiberboard box",
        "shipperDeclarationStatement": "LQ_air",
        "wattHours": 100,
        "lithiumContent": 1.5,
        "numberOfCells": 4,
        "numberOfBatteries": 2,
        "batteryConfiguration": "packed_with_equipment"
      },
      "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
      "productId": "RN03947--Z43121",
      "quantity": 3,
      "itemWeight": {
        "weightUnit": "lb",
        "weight": 50
      }
    }
  ],
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "phoneNumberCountryCode": "+2",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "\"87121\"",
    "addressType": "commercial",
    "addressLineComponents": {
      "streetName": "U.H. Fovisste Fuentes Brotantes",
      "primaryAddressNumber": "12",
      "secondaryAddressNumber": "302",
      "district": "Iztacalco",
      "neighborhood": "Agrícola Pantitlán"
    }
  },
  "shipOption": "Standard",
  "shipFromAddress": {
    "name": "Wile E. Coyote",
    "phoneNumberCountryCode": "+2",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "\"87121\"",
    "addressType": "commercial",
    "addressLineComponents": {
      "streetName": "U.H. Fovisste Fuentes Brotantes",
      "primaryAddressNumber": "12",
      "secondaryAddressNumber": "302",
      "district": "Iztacalco",
      "neighborhood": "Agrícola Pantitlán"
    }
  },
  "returnToAddress": {
    "name": "Wile E. Coyote",
    "phoneNumberCountryCode": "+2",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "\"87121\"",
    "addressType": "commercial",
    "addressLineComponents": {
      "streetName": "U.H. Fovisste Fuentes Brotantes",
      "primaryAddressNumber": "12",
      "secondaryAddressNumber": "302",
      "district": "Iztacalco",
      "neighborhood": "Agrícola Pantitlán"
    }
  },
  "injectionAddress": {
    "name": "Wile E. Coyote",
    "phoneNumberCountryCode": "+2",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "\"87121\"",
    "addressType": "commercial",
    "addressLineComponents": {
      "streetName": "U.H. Fovisste Fuentes Brotantes",
      "primaryAddressNumber": "12",
      "secondaryAddressNumber": "302",
      "district": "Iztacalco",
      "neighborhood": "Agrícola Pantitlán"
    }
  },
  "fulfillmentCenterId": "74065136-85c2-499b-b893-bd812ac0c00f",
  "packagingType": {
    "packagingMaterial": "box",
    "packagingSizeName": "13x12x10 Box",
    "shipiumPackagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
    "partnerPackagingTypeId": "rno-packaging-1",
    "requestPackagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 13,
      "width": 12,
      "height": 10
    },
    "packagingWeight": {
      "weightUnit": "lb",
      "weight": 50
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 50
  },
  "carrierSelection": {
    "operationalCost": 2.7,
    "calculatedBillableWeight": {
      "weightUnit": "lb",
      "weight": 50
    },
    "calculatedBillableCubicVolume": {
      "cubicVolumeUnit": "ft",
      "cubicVolume": 0.8
    },
    "laneMatch": {
      "laneId": "asdqwdq-qwd123ds-123asdwd-123asd",
      "partnerLaneId": "custom partner provided id"
    },
    "evaluatedServiceMethods": [
      {
        "injectionDetails": {
          "injectionCostDetails": {
            "injectionLineItemRate": 2.3,
            "injectionLineItemCurrencyCode": "usd"
          }
        },
        "rateCurrency": "usd",
        "lineItems": [
          {
            "name": "base",
            "rate": 2.3,
            "carrierSurchargeId": "123451239874980",
            "surchargeType": "extended_delivery_residential_ground",
            "lineItemType": "surcharge"
          }
        ],
        "estimatedDeliveryDateLocal": "2007-12-03T10:15:30"
      }
    ],
    "cancellationDateTime": "2024-10-31T10:50:11.123456Z",
    "currencyCode": "USD"
  },
  "carrierLabel": {
    "cancellationDateTime": "2024-10-31T10:50:11.123456Z",
    "manifestDateTime": "2024-10-30T10:50:11.123456Z",
    "billableWeight": {
      "weightUnit": "lb",
      "weight": 50
    },
    "billableCubicVolume": {
      "cubicVolumeUnit": "ft",
      "cubicVolume": 0.8
    },
    "internationalDocuments": [
      {
        "documentType": "commercial_invoice",
        "documentImage": {
          "documentEncoding": "base64"
        },
        "electronicallySubmitted": true
      }
    ],
    "hazardousMaterialsDocuments": [
      {
        "documentType": "OP_900LG",
        "documentImage": {
          "documentEncoding": "base64"
        },
        "electronicallySubmitted": true
      }
    ],
    "laneMatch": {
      "laneId": "asdqwdq-qwd123ds-123asdwd-123asd",
      "partnerLaneId": "custom partner provided id"
    },
    "trackingInfo": {
      "shippedDateTime": "2019-10-28T14:34:55.123456Z",
      "deliveredDateTime": "2019-10-28T14:34:55.123456Z",
      "currentStatus": {
        "eventDateTime": "2019-10-28T14:34:55.123456Z"
      },
      "events": [
        {
          "eventDateTime": "2019-10-28T14:34:55.123456Z"
        }
      ]
    }
  },
  "customsInfo": {
    "totalCustomsValue": 12.34,
    "totalCustomsValueCurrency": "usd",
    "customsDescription": "9 mm steel screws",
    "reasonForExport": "sale",
    "businessIndicator": "B2C",
    "invoiceDate": "1970-01-01",
    "invoiceNumber": "abcde-f12345-67890-abcdef",
    "europeanUnionInfo": {
      "vendorIossAddress": {
        "name": "Wile E. Coyote",
        "phoneNumberCountryCode": "+2",
        "company": "ACME",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "state": "NM",
        "countryCode": "US",
        "postalCode": "\"87121\"",
        "addressType": "commercial",
        "addressLineComponents": {
          "streetName": "U.H. Fovisste Fuentes Brotantes",
          "primaryAddressNumber": "12",
          "secondaryAddressNumber": "302",
          "district": "Iztacalco",
          "neighborhood": "Agrícola Pantitlán"
        }
      }
    },
    "exportReturnInfo": {
      "originalExportDate": "2026-08-19",
      "originalExportTrackingId": "2647515076",
      "originalOutboundCarrier": "DHL EXPRESS"
    },
    "ultimateConsigneeAddress": {
      "name": "Wile E. Coyote",
      "phoneNumberCountryCode": "+2",
      "company": "ACME",
      "street1": "123 Main St.",
      "street2": "Suite 42",
      "city": "Albuquerque",
      "state": "NM",
      "countryCode": "US",
      "postalCode": "\"87121\"",
      "addressType": "commercial",
      "addressLineComponents": {
        "streetName": "U.H. Fovisste Fuentes Brotantes",
        "primaryAddressNumber": "12",
        "secondaryAddressNumber": "302",
        "district": "Iztacalco",
        "neighborhood": "Agrícola Pantitlán"
      }
    },
    "ultimateConsigneeType": "direct_consumer",
    "permitNumber": "12345",
    "customsItems": [
      {
        "customsValue": 12.34,
        "customsValueCurrency": "usd",
        "commodityDescription": "baby socks",
        "countryOfManufacture": "CN",
        "customsWeight": {
          "weightUnit": "lb",
          "weight": 50
        },
        "quantity": 3,
        "productId": "RN03947--Z43121",
        "standardizedProductIds": [
          {
            "type": "GTIN",
            "value": "0012345678905"
          }
        ],
        "manufacturerProductId": "MPN-77B-XL",
        "harmonizedTariffNumber": "6402918005",
        "importHarmonizedTariffNumber": "6402918005",
        "electronicExportCommodityInformation": {
          "exportType": "domestic",
          "exportInformationCode": "LC",
          "scheduleBInformation": {
            "scheduleBNumber": "6404195500"
          },
          "eccnNumber": "EAR99",
          "exportLicenseInformation": {
            "licenseType": "C33",
            "licenseExemptionCode": "NLR"
          }
        },
        "cpscCertificateOfCompliance": {
          "manufacturerAddress": {
            "name": "Wile E. Coyote",
            "phoneNumberCountryCode": "+2",
            "company": "ACME",
            "street1": "123 Main St.",
            "street2": "Suite 42",
            "city": "Albuquerque",
            "state": "NM",
            "countryCode": "US",
            "postalCode": "\"87121\"",
            "addressType": "commercial",
            "addressLineComponents": {
              "streetName": "U.H. Fovisste Fuentes Brotantes",
              "primaryAddressNumber": "12",
              "secondaryAddressNumber": "302",
              "district": "Iztacalco",
              "neighborhood": "Agrícola Pantitlán"
            }
          },
          "testingLabAddress": {
            "name": "Wile E. Coyote",
            "phoneNumberCountryCode": "+2",
            "company": "ACME",
            "street1": "123 Main St.",
            "street2": "Suite 42",
            "city": "Albuquerque",
            "state": "NM",
            "countryCode": "US",
            "postalCode": "\"87121\"",
            "addressType": "commercial",
            "addressLineComponents": {
              "streetName": "U.H. Fovisste Fuentes Brotantes",
              "primaryAddressNumber": "12",
              "secondaryAddressNumber": "302",
              "district": "Iztacalco",
              "neighborhood": "Agrícola Pantitlán"
            }
          }
        }
      }
    ],
    "incoterm": "DDP",
    "taxIdentificationNumber": "12345",
    "importerOfRecord": {
      "importerAddress": {
        "name": "Wile E. Coyote",
        "phoneNumberCountryCode": "+2",
        "company": "ACME",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "state": "NM",
        "countryCode": "US",
        "postalCode": "\"87121\"",
        "addressType": "commercial",
        "addressLineComponents": {
          "streetName": "U.H. Fovisste Fuentes Brotantes",
          "primaryAddressNumber": "12",
          "secondaryAddressNumber": "302",
          "district": "Iztacalco",
          "neighborhood": "Agrícola Pantitlán"
        }
      },
      "taxIdentificationNumbers": [
        {
          "number": "12345"
        }
      ]
    },
    "brokers": [
      {
        "brokerAddress": {
          "name": "Wile E. Coyote",
          "phoneNumberCountryCode": "+2",
          "company": "ACME",
          "street1": "123 Main St.",
          "street2": "Suite 42",
          "city": "Albuquerque",
          "state": "NM",
          "countryCode": "US",
          "postalCode": "\"87121\"",
          "addressType": "commercial",
          "addressLineComponents": {
            "streetName": "U.H. Fovisste Fuentes Brotantes",
            "primaryAddressNumber": "12",
            "secondaryAddressNumber": "302",
            "district": "Iztacalco",
            "neighborhood": "Agrícola Pantitlán"
          }
        },
        "taxIdentificationNumbers": [
          {
            "number": "12345"
          }
        ]
      }
    ],
    "soldTo": {
      "address": {
        "name": "Wile E. Coyote",
        "phoneNumberCountryCode": "+2",
        "company": "ACME",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "state": "NM",
        "countryCode": "US",
        "postalCode": "\"87121\"",
        "addressType": "commercial",
        "addressLineComponents": {
          "streetName": "U.H. Fovisste Fuentes Brotantes",
          "primaryAddressNumber": "12",
          "secondaryAddressNumber": "302",
          "district": "Iztacalco",
          "neighborhood": "Agrícola Pantitlán"
        }
      },
      "taxIdentificationNumbers": [
        {
          "number": "12345"
        }
      ]
    }
  },
  "deliverySignatureOption": "ResidentSignature",
  "lastMileDeliveryOptions": {
    "tip": {
      "type": "FIXED"
    },
    "tipForLabelCreate": {
      "type": "FIXED"
    }
  },
  "deliveryWindow": {
    "startWindow": "10:15:30",
    "endWindow": "10:15:30"
  },
  "pickupWindow": {
    "startWindow": "10:15:30",
    "endWindow": "10:15:30"
  },
  "emergencyResponseInfo": {
    "phoneNumber": "18005551234",
    "contactName": "CHEMTREC",
    "contractNumber": "CCN123456"
  },
  "shipmentRequestedDocuments": [
    {
      "documentImage": {
        "documentEncoding": "base64"
      }
    }
  ],
  "payorAccounts": [
    {
      "payorAccountAddress": {
        "name": "Wile E. Coyote",
        "phoneNumberCountryCode": "+2",
        "company": "ACME",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "state": "NM",
        "countryCode": "US",
        "postalCode": "\"87121\"",
        "addressType": "commercial",
        "addressLineComponents": {
          "streetName": "U.H. Fovisste Fuentes Brotantes",
          "primaryAddressNumber": "12",
          "secondaryAddressNumber": "302",
          "district": "Iztacalco",
          "neighborhood": "Agrícola Pantitlán"
        }
      }
    }
  ],
  "desiredDeliveryDateLocal": "2007-12-03T10:15:30",
  "estimatedDeliveryDateLocal": "2007-12-03T10:15:30"
}

Changes

  • 3edfc3693c7bRevision changes
    • warning

      deleted the header request parameter X-DELEGATED-PARTNER-ID

    • warning

      added the new gal enum value to the /// response property for the response status

    • warning

      added the new gal enum value to the /// response property for the response status

    • warning

      added the new gal enum value to the ///// response property for the response status

    • warning

      added the new gal enum value to the ///// response property for the response status

    • info

      added the new optional request property /

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status