Guides

Register a Customer Order

Suggest Edits

Syntax

This example shows the syntax:

shipiumClient.createOrder(partnerOrderId, orderItems); // returns a promise

Parameters

This table shows the parameters used:

Parameter (type)Description
partnerOrderId (string)The orderId of a customer's order.
orderItems (object array)A collection of objects representing the products and quantities ordered.

Sample parameter set

This example shows sample parameters:

[
  { productId: '12345', quantity: 2 },
  { productId: '54321', quantity: 1 },
]

Sample return value

This example shows the response:

{
    shipiumOrderId: 'de2374f7-de12-447d-81dc-695934aac8ca',
    partnerOrderId: '123456789',
    orderedDateTime: '2020-04-03T22:33:01.162Z',
    deliveryEstimateQuantities: {
        'cf66e167-fcba-4dbd-85fc-bfce8a24bae2': 2,
        'a556e850-2354-4d8c-9693-3b94656b627b': 1,
    }
  }

Example usage

This example shows the usage:

var orderItems = [
    { productId: '12345', quantity: 2 },
    { productId: '54321', quantity: 1 },
  ];

  window.shipiumClient.createOrder('123456789', orderItems);

📘

More information on the API responses

As with all Shipium API responses, this API follows the API Response Codes standards unless otherwise specified.

Updated 9 months ago