Sign in

v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB
pack-ship-orchestration

Search for existing orders.

get/api/v1/packShip/order

Query parameters

tenantIdstring

Whether to constrain the search to a specified Shipium tenantId.

orderIdstring[]

Order ids to constrain results by.

associatedIdentifierstring[]

Search by associated identifiers. Identifiers are not constrained to be unique across orders.

fromDatestring date-time

Bounds of the oldest orderDate to search for orders on

toDatestring date-time

Bounds of the newest orderDate to search for orders on

orderStatusstring[]

Order statuses to constrain results by

carrierTrackingIdstring[]

Carrier tracking ids to constrain results by

anchorstring

Identifier for the current page of data.

countinteger

The number results to include on each page of the response

Headers

X-DELEGATED-PARTNER-IDstring

Response

The results of the order.

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

Fulfillment methodology of the shipment.

orderSource'shipium' | 'external'

The source of this order whether it is from the shipium system or externally created

tenantIdstring

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

shipiumOrderIdstring required

Identification use to represent the group of delivery estimates purchased.

partnerOrderIdstring

The unique identifier representing this order.

orderedDateTimestring date-time required

The timestamp for when the customer ordered the product. The timestamp must be a valid ISO 8601 timestamp

associatedIdentifiersstring[]

Associated identifiers that are indexed to identify this order. This can be an LPN for instance that is bound to the order. Can be searched but not interchangeable with orderId.

shipOptionstring

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

originIdstring

Origin where the order is assigned to. Cannot be assigned if shipFromAddress is also populated

currencyCodestring

Currency used in the transaction resulting in the order.

orderStatus'open' | 'open_split' | 'complete' | 'complete_multiship' | 'cancelled' | 'partial_ship' | 'error'

State of the order.

Example response

[
  {
    "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
    "partnerOrderId": "myCustomPartnerOrderId123",
    "orderedDateTime": "2019-10-28T14:34:55.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
        }
      }
    ],
    "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"
      }
    },
    "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"
      }
    },
    "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"
          }
        }
      },
      "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",
          "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"
          }
        ]
      }
    },
    "orderFulfillmentParameters": {
      "deliveryParameters": {
        "businessDaysOfTransit": 3,
        "deliverySignatureOption": "resident_signature",
        "deliveryWindow": {
          "startWindow": "10:15:30",
          "endWindow": "10:15:30"
        },
        "desiredDeliveryDate": "2019-10-31T20:00:00Z",
        "lastMileDeliveryOptions": {
          "tip": {
            "type": "FIXED"
          },
          "tipForLabelCreate": {
            "type": "FIXED"
          }
        },
        "preferredCarrierDeliveryDateTime": "2019-10-31T20:00:00Z"
      },
      "splitParameters": [
        {
          "orderItemQuantities": [
            {
              "orderItemReferenceIdentifier": "someIdentifier",
              "productId": "RN03947--Z43121",
              "quantity": 3
            }
          ],
          "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
          }
        }
      ],
      "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
      }
    },
    "orderFulfillmentInfo": {
      "shipments": [
        {
          "shipiumShipmentId": "0840c7a2-e6ab-4755-8aa2-9a986297ad6d",
          "partnerShipmentId": "myCustomPartnerShipmentId123",
          "shipiumOrderId": "0840c7a2-e6ab-4755-8aa2-9a986297ad6d",
          "partnerOrderId": "myCustomPartnerOrderId123",
          "orderItemQuantities": [
            {
              "orderItemReferenceIdentifier": "someIdentifier",
              "productId": "RN03947--Z43121",
              "quantity": 3
            }
          ]
        }
      ],
      "unfulfilledItems": [
        {
          "orderItemReferenceIdentifier": "someIdentifier",
          "productId": "RN03947--Z43121",
          "quantity": 3
        }
      ]
    }
  }
]