SHshipium
plans

Endpoint to retrieve an existing order from a plan.

Changed on
get/api/v1/fe/plans/{planId}/orders/{partnerOrderId}

Request

Path parameters

planIdstring required
partnerOrderIdstring required

Response

Specific order information from a plan.

planIdstring required

Unique id of the plan generated by Shipium.

orderIdstring required

Unique id of the order generated by Shipium.

partnerOrderIdstring required

Partner provided ID for this order.

currencyCode'chf' | 'usd' | 'not_set' | 'unknown' required

The currency code, in ISO-4217 format, represents the currency the order was purchased in.

desiredDeliveryDatestring

The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date or datetime the package is intended to arrive to the customer. This will be used to determine the most appropriate service method when generating a label

businessDaysOfTransitinteger

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

shipOptionstring

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

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.

orderedDateTimestring date-time required

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

partnerReferenceIdentifierstring

Reference external identifier explicitly provided by the partner. Used for reporting purposes.

partnerReferenceIdentifier2string

Second reference external identifier explicitly provided by the partner. Used for reporting purposes.

shipmentTagsstring[]

Free-form list of shipment tags for this order, echoed from the plan request. Matches the shipmentTags field on the Carrier Selection API request.

Example response

{
  "currencyCode": "usd",
  "desiredDeliveryDate": "2019-10-31T20:00:00Z",
  "businessDaysOfTransit": 3,
  "shipOption": "Standard",
  "shippedDateTime": "2019-10-29T09:12:33.123456Z",
  "destinationAddress": {
    "name": "Wile E. Coyote",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "region": "NM",
    "countryCode": "US",
    "postalCode": "\"87121\"",
    "addressType": "commercial"
  },
  "orderedDateTime": "2019-10-28T14:34:55.123456Z",
  "orderItemQuantities": [
    {
      "productId": "RN03947--Z43121"
    }
  ],
  "proposedShipments": [
    {
      "cost": {
        "performance": {
          "estimatedDeliveryDateLocal": "2007-12-03T10:15:30"
        }
      },
      "destinationAddress": {
        "name": "Wile E. Coyote",
        "company": "ACME",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "region": "NM",
        "countryCode": "US",
        "postalCode": "\"87121\"",
        "addressType": "commercial"
      },
      "packagingType": {
        "linearDimensions": {
          "linearUnit": "in",
          "length": 13,
          "width": 12,
          "height": 10
        },
        "weight": {
          "weightUnit": "lb",
          "weight": 50
        },
        "maxContentWeight": {
          "weightUnit": "lb",
          "weight": 50
        }
      },
      "shipmentItems": [
        {
          "productId": "RN03947--Z43121",
          "linearDimensions": {
            "linearUnit": "in",
            "length": 13,
            "width": 12,
            "height": 10
          },
          "weight": {
            "weightUnit": "lb",
            "weight": 50
          }
        }
      ],
      "totalWeight": {
        "weightUnit": "lb",
        "weight": 50
      }
    }
  ],
  "unfulfillableItems": [
    {
      "orderItem": {
        "productId": "RN03947--Z43121"
      }
    }
  ]
}

Changes