Perishable Item Support

Learn how to designate the contents of a package as containing one or more perishable items when calling the Shipium APIs.

About perishable items

Perishable items are a specific category of items that can be shipped, but carriers prefer to be notified about them.

These items are prone to becoming unsafe for consumption if they are not shipped at the appropriate temperature. Shipping them at the appropriate temperature prevents spoilage.

Although shipping perishable items usually doesn't affect the overall cost of packages, we highly recommend you provide this information. This is so we can share it with your organization's carriers for any relevant shipments. This can ensure that proper precautions can be taken.

πŸ‘‰

Dry ice usage

If you're using dry ice to cool perishable goods in a shipment, you'll need to include hazmat details in your call to the Shipium APIs, as described in Hazardous Materials Support.

Specifying perishable items in shipments

In order to allow Shipium to choose the best carrier and method for your packages, your organization will need to specify that one or more items contained in the shipment are perishable when calling Shipium's application programming interfaces (APIs). In addition to other item properties that are passed, such as product ID and quantity, you can specify that an item is perishable.

Perishable item information is provided within shipments as part of the orderItemQuantities field. Specifically, you should include perishable in the field shipmentParameters.orderItemQuantities.productDetails for any applicable products, as shown in the example below.

Short example of additional details in the body

{
  ...
  "orderItemQuantities": [
    {
        "productDetails": ["perishable"],
        "productId": "12345678",
        "quantity": 1,
        "hazmatInfo": {}
    }
],
...
}
  

Example Full API request including perishable item

The following example shows perishable item information passed as part of the productDetails:

curl --location 'https://shiptime-service.stage.shipium.com/api/v1/shipment/carrierselection/label' \
--header 'X-MEGA-PROCESS-VERSION-OVERRIDE: 2' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <>' \
--data '{
    "currencyCode": "usd",
    "generateLabel": true,
    "labelParameters": {
        "currencyCode": "usd",
        "customLabelEntries": {},
        "testMode": true,
        "includeLabelImagesInResponse": true,
        "labelFormats": [
            "zpl"
        ],
        "manifest": true
    },
    "shipmentParameters": {
        "fulfillmentContext": "ana-upsmi",
        "shippedDateTime": "2023-05-06T11:00:00.000Z",
        "orderedDateTime": "2023-06-06T16:30:00.000Z",
        "desiredDeliveryDate": "2023-06-10T11:00:00.000Z",
        "partnerShipmentId": null,
        "referenceIdentifier": "166165427",
        "purchaseOrderIdentifier": "00000199990166165427",
        "destinationAddress": {
            "name": "Hector Test",
            "phoneNumber": "5555555555",
            "phoneNumberCountryCode": null,
            "emailAddress": null,
            "company": "N/A",
            "street1": "2901 ne blakely st unit 400",
            "street2": null,
            "city": "SEATTLE",
            "state": "WA",
            "countryCode": "US",
            "postalCode": "98103",
            "addressType": "residential"
        },
             "shipFromAddress": {
            "name": "JGC Stord",
            "phoneNumber": null,
            "phoneNumberCountryCode": null,
            "emailAddress": null,
            "company": "N/A",
            "street1": "4285 Buford Hwy",
            "street2": null,
            "city": "Atlanta",
            "state": "GA",
            "countryCode": "US",
            "postalCode": "30345",
            "addressType": "commercial"
        },
        "orderItemQuantities": [
            {
                "productDetails": ["perishable"],
                "productId": "12345678",
                "quantity": 1,
                "hazmatInfo": {}
            }
        ],
        "packagingType": {
            "packagingMaterial": "box",
            "packagingSizeName": "test-package",
            "packagingWeight": {
                "weight": "15",
                "weightUnit": "lb"
            },
            "linearDimensions": {
                "height": 6.13,
                "length": 12,
                "linearUnit": "in",
                "width": 0.7
            }
        },
        "shipmentTags": [
            "test"
        ],
        "totalWeight": {
            "weight": "15",
            "weightUnit": "lb"
        }
    }
}