OpenBorder credential requirements

Prior to shipping with OpenBorder, you must configure credentials in the Shipium Console. You'll provide a token ID and brand code for both production and test mode.

Additional requirements

OpenBorder requires that you include either the product SKU number or the order number from OpenBorder in your API call. For single-parcel shipments, one of the following additional fields should be nested in the shipmentParameters property. For multi-parcel shipments, the field should be included in multiParcelShipmentParameters.

Reference Field	Required/Optional	Field Properties	Description
`orderItemQuantities .productId`	Conditional (required if not providing the `partnerOrderId`)	String Ex.: `123454321`	If you opt to provide the SKU number from your OpenBorder order, you will include it as the product ID value.
`orderItemQuantities .partnerOrderId`	Conditional (required if not providing the `productId`)	String Ex.: `myCustomPartnerOrderId123`	If you choose to provide the order number from your OpenBorder order, you will include it as the partner order ID value.

A snippet of the JSON request for the API call with each field is included. Both examples are for a single-parcel shipment. The request field for a multi-parcel shipment would be included in multiParcelShipmentParameters.

This request snippet includes the product ID field.

{
"shipmentParameters": {

  "orderItemQuantities": [
    {
      "productId": "123454321",
...
    }
]
}

This request snippet includes the partner order ID field.

{
"shipmentParameters": {

  "orderItemQuantities": [
    {
      "partnerOrderId": "myCustomPartnerOrderId123",
...
    }
]
}

Resources

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