POST /orders – shipcloud.io API

Create a new order.

post/orders

Request

Base URL: https://api.shipcloud.io/v1
URL: https://api.shipcloud.io/v1/orders
Auth: HTTP basic

Request body

placed_atstring date-time

Date that shows When the order has been placed

external_order_idstring

An external identifier for this order

external_customer_idstring

An external identifier for the customer who has placed the order

total_pricenumber required

The total amount of the order

total_vatnumber required

The total VAT of the order

currency'EUR' | 'USD' | 'GBP' required

Currency that the customer uses for paying the order

refundable_untilstring date-time

Used to disable returns for the whole order after a specific time (a Return Portal Plus feature).

refund_deduction_amountnumber

Part of the order's return costs the customer has to pay (a Return Portal Plus feature).

total_weightnumber

Total weight of all items

weight_unit'kg'

The unit associated with the weight. Mandatory when total_weight is given

Example request

{
  "order_line_items": [
    {
      "returnability": {
        "returnable_until": "2022-05-18T12:30:15+02:00"
      }
    }
  ]
}

Response

An order