For AI agents: visit https://docs.shipium.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Get started Skip link to Get started

To use the Pack Application (App) API, you can follow the instructions on this page. The Shipium Pack App API assumes you're using one of the authentication mechanisms detailed in our authentication documentation.

🔐

Authentication for API Calls Skip link to Authentication for API Calls

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

🔐

Authenticating for Curl

Open Recipe

Using the Pack App API, you can:

• create an order;
• submit an order;
• split an order;
• search an order; or
• get an order.

General information about the Pack App within the Shipium platform can be found in the Pack Application documentation. Guidance for using the Pack App within the Shipium Console to scan orders and print labels as well as search order details is included in the Pack Application (Pack App) documentation.

Create an order with the Pack App API Skip link to Create an order with the Pack App API

The endpoint for creating an order with the Pack App API is included in the table below.

Example cURL call to create an order Skip link to Example cURL call to create an order

This example shows a request to create an order.

cURL

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

Example request body to create an order Skip link to Example request body to create an order

The following fields should be included in your JSON request.

JSON

{
  "fulfillmentType": "customer",
  "orderSource": "external",
  "currencyCode": "USD",
  "partnerOrderId": "partner-order:12345",
  "associatedIdentifiers": [\
    "lpn-barcode:12345"\
  ],
  "tenantId": null,
  "orderedDateTime": "2025-03-15T10:10:00.111111Z",
  "orderItemQuantities": [\
    {\
      "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
      "hazmat": false,\
      "hazmatInfo": null,\
      "productTaxCode": null,\
      "nmfcCode": null,\
      "nmfcFreightClass": null,\
      "productId": "partner-product:12345",\
      "quantity": 3,\
      "productDetails": null,\
      "itemWeight": {\
        "weight": "2.5",\
        "weightUnit": "lb"\
}\
    }\
  ],
  "shipFromAddress": null,
  "originId": "<ORIGIN-ID/PARTNER-PROVIDED-ORIGIN-ID FROM PARTNER CONFIG IN SHIPIUM>",
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "phoneNumber": "9995551234",
    "phoneNumberCountryCode": "+1",
    "emailAddress": "wile.e.coyote@example.com",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "residential",
    "addressLineComponents": null
  },
  "shipOption": null,
  "customsInfo": null,
  "totalDeclaredValue": null,
  "orderFulfillmentParameters": {
    "thirdPartyBillingSetId": null,
    "forceThirdPartyBilling": false,
    "fulfillmentContext": "<FCTX-ID/PARTNER-PROVIDED-FCTX-ID FROM PARTNER CONFIG IN SHIPIUM>",
    "fulfillmentContextId": null,
    "holdAtLocation": {
      "holdAtLocationId": "MyHALLocation",
      "useHoldAtLocation": true
    },
    "referenceIdentifier": "Order123",
    "partnerReferenceIdentifier": "PartnerRef789",
    "packagingType": null,
    "totalWeight": null,
    "splitOrder": false,
    "deliveryParameters": {
      "applyToSplits": false,
      "businessDaysOfTransit": null,
      "deliveryNote": null,
      "deliverySignatureOption": "none",
      "deliveryWindow": null,
      "desiredDeliveryDate": "2025-04-15T20:00:00Z",
      "desiredDeliveryDateOptions": null,
      "lastMileDeliveryOptions": null,
      "preferredCarrierDeliveryDateTime": null,
      "saturdayDelivery": false,
      "carrierServiceMethodAllowList": [\
        "ups-ground-service-method",\
        "fedex-home-delivery-service-method"\
  ],
    }
  }
}

Example response body for an order creation Skip link to Example response body for an order creation

JSON

{
  "fulfillmentType": "customer",
  "orderSource": "external",
  "currencyCode": "USD",
  "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
  "partnerOrderId": "partner-order:12345",
  "associatedIdentifiers": [\
    "lpn-barcode:12345"\
  ],
  "tenantId": null,
  "orderedDateTime": "2025-03-15T10:10:00.111111Z",
  "orderItemQuantities": [\
    {\
      "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",\
      "partnerOrderId": "partner-order:12345",\
      "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
      "hazmat": false,\
      "hazmatInfo": null,\
      "productTaxCode": null,\
      "nmfcCode": null,\
      "nmfcFreightClass": null,\
      "productId": "partner-product:12345",\
      "quantity": 3,\
      "productDetails": null,\
      "itemWeight": {\
        "weight": "2.5",\
        "weightUnit": "lb"\
}\
    }\
  ],
  "shipFromAddress": null,
  "originId": "<ORIGIN-ID/PARTNER-PROVIDED-ORIGIN-ID FROM PARTNER CONFIG IN SHIPIUM>",
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "phoneNumber": "9995551234",
    "phoneNumberCountryCode": "+1",
    "emailAddress": "wile.e.coyote@example.com",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "residential",
    "addressLineComponents": null
  },
  "shipOption": null,
  "customsInfo": null,
  "totalDeclaredValue": null,
  "orderFulfillmentParameters": {
    "thirdPartyBillingSetId": null,
    "forceThirdPartyBilling": false,
    "fulfillmentContext": "<FCTX-ID/PARTNER-PROVIDED-FCTX-ID FROM PARTNER CONFIG IN SHIPIUM>",
    "fulfillmentContextId": null,
    "holdAtLocation": {
      "holdAtLocationId": "MyHALLocation",
      "useHoldAtLocation": true
    },
    "referenceIdentifier": "Order123",
    "partnerReferenceIdentifier": "PartnerRef789",
    "packagingType": null,
    "totalWeight": null,
    "splitOrder": false,
    "deliveryParameters": {
      "applyToSplits": false,
      "businessDaysOfTransit": null,
      "deliveryNote": null,
      "deliverySignatureOption": "none",
      "deliveryWindow": null,
      "desiredDeliveryDate": "2025-04-15T20:00:00Z",
      "desiredDeliveryDateOptions": null,
      "lastMileDeliveryOptions": null,
      "preferredCarrierDeliveryDateTime": null,
      "saturdayDelivery": false,
      "carrierServiceMethodAllowList": [\
        "ups-ground-service-method",\
        "fedex-home-delivery-service-method"\
  ]
    }
  }
}

Set delivery parameters at order creation Skip link to Set delivery parameters at order creation

You can specify delivery preferences when creating an order using the deliveryParameters object within orderFulfillmentParameters. These settings are stored on the order and automatically applied when generating a label at pack/ship time. This allows packers and shippers to focus on packing and shipping without needing to specify delivery options at runtime.

Any equivalent parameters passed at pack/ship time will override the values stored in deliveryParameters.

Request and response fields for creating an order Skip link to Request and response fields for creating an order

The following tables provide required, conditional, and optional fields for calling the Pack App API to create an order. Optional fields such as those in customsInfo would only be required for international shipments. You can find additional support in the Pack App API Reference.

Required fields Skip link to Required fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

🚧

Use with caution Skip link to Use with caution

Using carrierServiceMethodAllowList significantly limits shipping options during carrier selection. This may result in higher shipping costs or a "no eligible carriers" error if none of the specified methods meet the shipment requirements. Use this feature only when you need to enforce specific shipping methods. You can find more information in the Specify Carrier Service and Method documentation.

Response attributes Skip link to Response attributes

The response attributes for creating an order are defined in the following table. Response attributes with associated request field descriptions in the table above are not included here.

Submit an order Skip link to Submit an order

The endpoint for submitting an order for fulfillment with the Pack App API is included in the table below.

Required path element.orderId (Replace with either Shipium's order identifier or your own, if provided when the order was created.)

Example cURL call to submit an order Skip link to Example cURL call to submit an order

This example shows a request to submit an order for standard fulfillment.

cURL

curl --request POST \
--url https://api.shipium.com/api/v1/packShip/order/4dc43fff-c3af-4d7b-8a18-e01f2b4cb312/submit \
--header 'accept: application/json' \
--header $AUTHSTRING \
--header 'content-type: application/json' \
--data 'INSERT REQUEST BODY FROM BELOW'

Example request body to submit an order for a standard complete shipment Skip link to Example request body to submit an order for a standard complete shipment

JSON

{
  "generateLabel": true,
  "packagingType": {
    "packagingMaterial": "box",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 12.0,
      "width": 10.0,
      "height": 8.0
    },
    "packagingWeight": {
      "weightUnit": "lb",
      "weight": 0.5
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 3.2
  },
  "labelParameters": {
    "labelFormats": ["pdf", "png"],
    "includeLabelImagesInResponse": true,
    "testMode": false,
    "eligibleForManifest": true
  },
  "shipmentParameters": {
    "currencyCode": "USD",
    "shippedDateTime": "2025-01-15T10:00:00Z",
    "desiredDeliveryDate": "2025-01-17T17:00:00Z"
  },
  "carrierSelectionOptions": {
    "carrierServiceMethodAllowList": ["ups-ground-service-method", "fedex-ground-service-method"]
  }
}

Example response body for standard complete shipment order submit Skip link to Example response body for standard complete shipment order submit

JSON

{
  "fulfillmentType": "customer",
  "orderSource": "external",
  "tenantId": "tenant-123",
  "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
  "partnerOrderId": "partner-order:12345",
  "orderedDateTime": "2025-01-15T08:00:00.000Z",
  "orderItemQuantities": [\
    {\
      "productId": "SKU-12345",\
      "quantity": 3\
    }\
  ],
  "associatedIdentifiers": [],
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "street1": "123 Main St.",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "residential"
  },
  "orderStatus": "complete",
  "orderFulfillmentInfo": {
    "shipments": [\
      {\
        "shipiumShipmentId": "ship-001-abc123",\
        "partnerShipmentId": null,\
        "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",\
        "partnerOrderId": "partner-order:12345",\
        "type": "complete",\
        "carrierTrackingId": "1Z999AA1234567890",\
        "carrier": "ups",\
        "carrierServiceMethodId": "ups-ground-service-method",\
        "orderItemQuantities": [\
          {\
            "productId": "SKU-12345",\
            "quantity": 3\
          }\
        ]\
      }\
    ],
    "unfulfilledItems": []
  }
}

Example request body to submit a split order (runtime split) Skip link to Example request body to submit a split order (runtime split)

JSON

{
  "generateLabel": true,
  "splitOrder": true,
  "splitParameters": {
    "reasonCode": "item_size",
    "orderItemQuantities": [\
      {\
        "productId": "SKU-12345",\
        "quantity": 2\
      }\
    ]
  },
  "packagingType": {
    "packagingMaterial": "box",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 10.0,
      "width": 8.0,
      "height": 6.0
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 2.0
  },
  "labelParameters": {
    "labelFormats": ["pdf"],
    "includeLabelImagesInResponse": true,
    "testMode": false
  },
  "shipmentParameters": {
    "currencyCode": "USD"
  }
}

Example response body for runtime split order submit (first split) Skip link to Example response body for runtime split order submit (first split)

JSON

{
  "fulfillmentType": "customer",
  "orderSource": "external",
  "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
  "partnerOrderId": "partner-order:12345",
  "orderedDateTime": "2025-01-15T08:00:00.000Z",
  "orderItemQuantities": [\
    {\
      "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
      "productId": "SKU-12345",\
      "quantity": 5\
    }\
  ],
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "street1": "123 Main St.",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "residential"
  },
  "orderStatus": "partial_ship",
  "orderFulfillmentInfo": {
    "shipments": [\
      {\
        "shipiumShipmentId": "ship-002-def456",\
        "partnerShipmentId": null,\
        "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",\
        "partnerOrderId": "partner-order:12345",\
        "parametersReferenceId": "runtime-split-001",\
        "type": "split",\
        "carrierTrackingId": "1Z999AA1234567891",\
        "carrier": "UPS",\
        "carrierServiceMethodId": "ups-ground-service-method",\
        "orderItemQuantities": [\
          {\
            "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
            "productId": "SKU-12345",\
            "quantity": 2\
          }\
        ]\
      }\
    ],
    "unfulfilledItems": [\
      {\
        "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
        "productId": "SKU-12345",\
        "quantity": 3\
      }\
    ]
  }
}

Example request body to submit a split order (pre-defined split reference) Skip link to Example request body to submit a split order (pre-defined split reference)

JSON

{
  "generateLabel": true,
  "splitOrder": true,
  "splitReferenceId": "split-001",
  "packagingType": {
    "packagingMaterial": "envelope",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 9.0,
      "width": 6.0,
      "height": 1.0
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 0.5
  },
  "labelParameters": {
    "labelFormats": ["pdf", "zpl"],
    "includeLabelImagesInResponse": false,
    "testMode": false
  },
  "shipmentParameters": {
    "currencyCode": "USD",
    "saturdayDelivery": false
  }
}

Example response body for pre-defined split order submit (using reference ID) Skip link to Example response body for pre-defined split order submit (using reference ID)

JSON

Request and response fields for submitting an order Skip link to Request and response fields for submitting an order

The following tables provide conditional and optional fields for calling the Pack App API to submit an order. You can find additional support in the Pack App API Reference.

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

Response attributes Skip link to Response attributes

The response attributes for submitting an order are defined in the following table. Response attributes with associated request field descriptions in the table above are not included here.

Split an order Skip link to Split an order

Split shipments functionality is integrated into the Pack App order submission process. To split shipments, you use the standard submit endpoint with additional split parameters. You can only create one split shipment per submit call. If you need to split an order into multiple shipments (e.g., 2 boxes), you'll need to make multiple calls to the submit endpoint with the different split configurations.

The endpoint for submitting a split shipment is the same as the standard order submission:

There are two ways to split an order: runtime splits and pre-defined splits.

Runtime splits Skip link to Runtime splits

This workflow is used when you want to define the split at the time of submission.

1. Create an order Skip link to 1. Create an order

First, you'll create an order using a standard call to POST /api/v1/packShip/order.

2. Submit the first split (runtime) Skip link to 2. Submit the first split (runtime)

Next, you'll submit the first split by calling POST /api/v1/packShip/order/{orderId}/submit and defining the split in the splitParameters object.

Example request body for runtime split Skip link to Example request body for runtime split

JSON

{
  "generateLabel": true,
  "splitOrder": true,
  "splitParameters": {
    "reasonCode": "item_size",
    "orderItemQuantities": [\
      {\
        "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
        "productId": "SKU-12345",\
        "quantity": 2\
      }\
    ]
  },
  "packagingType": {
    "packagingMaterial": "box",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 10.0,
      "width": 8.0,
      "height": 6.0
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 2.0
  },
  "labelParameters": {
    "labelFormats": [\
      "pdf"\
    ],
    "includeLabelImagesInResponse": true,
    "testMode": false
  },
  "shipmentParameters": {
    "currencyCode": "USD"
  }
}

Example response body for runtime split Skip link to Example response body for runtime split

JSON

Pre-defined splits Skip link to Pre-defined splits

This workflow is used when you want to define the splits on the order object ahead of time and then reference them during submission.

1. Create an order with pre-defined splits Skip link to 1. Create an order with pre-defined splits

First, you'll create an order by calling POST /api/v1/packShip/order, with the splitOrder flag set to true and define the splits in the splitParameters array.

Example request body for creating an order with pre-defined splits Skip link to Example request body for creating an order with pre-defined splits

JSON

{
  "fulfillmentType": "customer",
  "orderSource": "external",
  "partnerOrderId": "partner-order:12345",
  "orderedDateTime": "2025-03-15T10:10:00.111111Z",
  "orderItemQuantities": [\
    {\
      "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
      "productId": "SKU-12345",\
      "quantity": 5\
    }\
  ],
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "street1": "123 Main St.",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121"
  },
  "orderFulfillmentParameters": {
    "splitOrder": true,
    "splitParameters": [\
      {\
        "splitReferenceId": "split-A",\
        "reasonCode": "item_size",\
        "orderItemQuantities": [\
          {\
            "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
            "productId": "SKU-12345",\
            "quantity": 2\
          }\
        ]\
      },\
      {\
        "splitReferenceId": "split-B",\
        "reasonCode": "item_size",\
        "orderItemQuantities": [\
          {\
            "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
            "productId": "SKU-12345",\
            "quantity": 3\
          }\
        ]\
      }\
    ]
  }
}

2. Submit a pre-defined split Skip link to 2. Submit a pre-defined split

Next, you'll submit one of the pre-defined splits by calling POST /api/v1/packShip/order/{orderId}/submit and referencing the splitReferenceId.

Example request body for submitting a pre-defined split Skip link to Example request body for submitting a pre-defined split

JSON

{
  "generateLabel": true,
  "splitOrder": true,
  "splitReferenceId": "split-A",
  "packagingType": {
    "packagingMaterial": "box",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 10.0,
      "width": 8.0,
      "height": 6.0
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 2.0
  },
  "labelParameters": {
    "labelFormats": [\
      "pdf"\
    ],
    "includeLabelImagesInResponse": true,
    "testMode": false
  }
}

Example response body for submitting a pre-defined split Skip link to Example response body for submitting a pre-defined split

JSON

How to submit remaining items for split shipments Skip link to How to submit remaining items for split shipments

After you have created one or more split shipments, you can submit the remaining items of the order in a final shipment. To do this, you make a standard call to the POST /api/v1/packShip/order/{orderId}/submit endpoint without including the splitOrder, splitReferenceId, or splitParameters fields. This will create a final shipment containing all remaining unfulfilled items from the order.

Example request body to submit remaining items Skip link to Example request body to submit remaining items

JSON

{
  "generateLabel": true,
  "packagingType": {
    "packagingMaterial": "box",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 12.0,
      "width": 10.0,
      "height": 8.0
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 1.2
  },
  "labelParameters": {
    "labelFormats": [\
      "pdf"\
    ],
    "includeLabelImagesInResponse": true,
    "testMode": false
  },
  "shipmentParameters": {
    "currencyCode": "USD"
  }
}

Example response body for submitting remaining items Skip link to Example response body for submitting remaining items

JSON

Request and response fields for split shipments Skip link to Request and response fields for split shipments

The following tables provide required and conditional fields for split shipment functionality added to the standard submit request.

Required fields Skip link to Required fields

Conditional fields Skip link to Conditional fields

Response attributes Skip link to Response attributes

The response includes standard shipment fields plus these split-specific attributes.

Tracking split orders Skip link to Tracking split orders

When you retrieve an order (Get an Order) that has been split using GET /api/v1/packShip/order/{orderId}, the response will include:

• fulfillmentInfo.shipments. An array of shipment objects that have been created for the order
• fulfillmentInfo.unfulfilledItems. An array of items that are not yet fulfilled for a split order

This allows you to track the progress of each split and identify any remaining unfulfilled items.

Search an order Skip link to Search an order

The search endpoint returns results in pages. Order search results will contain the following response headers with data on how to access the previous and next pages in the total body of results based on the count (page size) request parameter you pass in your API call.

Response header element.X-Page-Next represents the start of the next page of order search results. To access the next page, you'll call the Order Search API again with the value of this field in the anchor request parameter. If this response header is null or missing, it means that this is the last page of the order search results.

Response header element.X-Page-Previous represents the start of the previous page of order search results. To access the previous page, you'll call the Order Search API again with the value of this field in the anchor request parameters. If this response header is null or missing, it means that this is the first page of the order search results.

Response header element.X-Total-Count represents the total number of orders matching the request parameters sent in the order search request.

The endpoint for searching an order with the Pack App API is included in the table below.

Example cURL call to search an order Skip link to Example cURL call to search an order

This example shows a request to search an order.

cURL

curl --request GET \
--location "https://api.shipium.com/api/v1/packShip/order/search?associatedIdentifiers=lpn-barcode%3A12345&anchor=0&count=50" \
--header 'Accept: application/json' \
--header $AUTHSTRING

Example response body for an order search Skip link to Example response body for an order search

JSON

[\
  {\
    "fulfillmentType": "customer",\
    "orderSource": "external",\
    "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",\
    "partnerOrderId": "partner-order:12345",\
    "associatedIdentifiers": [\
      "lpn-barcode:12345"\
    ],\
    "tenantId": null,\
    "orderedDateTime": "2025-03-15T10:10:00.111111Z",\
    "orderItemQuantities": [\
      {\
        "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",\
        "partnerOrderId": "partner-order:12345",\
        "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
        "hazmat": false,\
        "hazmatInfo": null,\
        "productTaxCode": null,\
        "nmfcCode": null,\
        "nmfcFreightClass": null,\
        "productId": "partner-product:12345",\
        "quantity": 3,\
        "productDetails": null\
      }\
    ],\
    "shipFromAddress": null,\
    "originId": "<ORIGIN-ID/PARTNER-PROVIDED-ORIGIN-ID FROM PARTNER CONFIG IN SHIPIUM>",\
    "destinationAddress": {\
      "name": "Wile E. Coyote",\
      "phoneNumber": "9995551234",\
      "phoneNumberCountryCode": "+1",\
      "emailAddress": "wile.e.coyote@example.com",\
      "company": "ACME",\
      "street1": "123 Main St.",\
      "street2": "Suite 42",\
      "city": "Albuquerque",\
      "state": "NM",\
      "countryCode": "US",\
      "postalCode": "87121",\
      "addressType": "residential",\
      "addressLineComponents": null\
    },\
    "shipOption": null,\
    "customsInfo": null,\
    "totalDeclaredValue": null,\
    "orderFulfillmentParameters": {\
      "saturdayDelivery": false,\
      "thirdPartyBillingSetId": null,\
      "forceThirdPartyBilling": false,\
      "fulfillmentContext": "<FCTX-ID/PARTNER-PROVIDED-FCTX-ID FROM PARTNER CONFIG IN SHIPIUM>",\
      "fulfillmentContextId": null,\
      "packagingType": null,\
      "totalWeight": null\
    }\
  }\
]

Request and response fields for searching an order Skip link to Request and response fields for searching an order

The following tables provides optional fields for calling the Pack App API to search an order. You can find additional support in the Pack App API Reference.

Optional fields Skip link to Optional fields

Response attributes Skip link to Response attributes

The response attributes for searching an order are defined in the following table. Some response attributes are associated with the request fields described in the request fields table for calling the Pack App API to create an order. Those attributes are not listed here.

Get an order Skip link to Get an order

The endpoint for getting an order with the Pack App API is included in the table below.

Required path element.orderId or partnerOrderId (Replace with either Shipium’s order identifier or your own, if provided when the order was created.)

You can find additional details in the API Reference.

Example cURL call to get an order Skip link to Example cURL call to get an order

This example shows a request to get an order. You'll call the api/v1/packShip/order endpoint and append your own order number to the call, like the one shown in the example.

cURL

curl --request GET \
--location "https://api.shipium.com/api/v1/packShip/order/4dc43fff-c3af-4d7b-8a18-e01f2b4cb312" \
--header 'Accept: application/json' \
--header $AUTHSTRING

Example response body for getting an order Skip link to Example response body for getting an order

JSON

{
  "fulfillmentType": "customer",
  "orderSource": "external",
  "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",
  "partnerOrderId": "partner-order:12345",
  "associatedIdentifiers": [\
    "lpn-barcode:12345"\
  ],
  "tenantId": null,
  "orderedDateTime": "2025-03-15T10:10:00.111111Z",
  "orderItemQuantities": [\
    {\
      "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312",\
      "partnerOrderId": "partner-order:12345",\
      "orderItemReferenceIdentifier": "partner-order:12334_item:1",\
      "hazmat": false,\
      "hazmatInfo": null,\
      "productTaxCode": null,\
      "nmfcCode": null,\
      "nmfcFreightClass": null,\
      "productId": "partner-product:12345",\
      "quantity": 3,\
      "productDetails": null\
    }\
  ],
  "shipFromAddress": null,
  "originId": "<ORIGIN-ID/PARTNER-PROVIDED-ORIGIN-ID FROM PARTNER CONFIG IN SHIPIUM>",
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "phoneNumber": "9995551234",
    "phoneNumberCountryCode": "+1",
    "emailAddress": "wile.e.coyote@example.com",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "residential",
    "addressLineComponents": null
  },
  "shipOption": null,
  "customsInfo": null,
  "totalDeclaredValue": null,
  "orderFulfillmentParameters": {
    "saturdayDelivery": false,
    "thirdPartyBillingSetId": null,
    "forceThirdPartyBilling": false,
    "fulfillmentContext": "<FCTX-ID/PARTNER-PROVIDED-FCTX-ID FROM PARTNER CONFIG IN SHIPIUM>",
    "fulfillmentContextId": null,
    "packagingType": null,
    "totalWeight": null
  },
  "fulfillmentInfo": {
    "shipments": [],
    "unfulfilledItems": []
}

Response attributes for getting an order Skip link to Response attributes for getting an order

The response attributes for getting an order are defined in the following table. Some response attributes are associated with the request fields described in the request fields table for calling the Pack App API to create an order. Those attributes are not listed here.

Resources Skip link to Resources

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

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support

Updated 27 days ago

Did this page help you?

Yes

No

Copy Page

🦉

Recipe Title

Recipe Description

​x

1{"success":true}

Are you sure?