Getting a list of previously created orders

get/orders

Request

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

Query parameters

external_order_idstring

Filter orders by their external order id

external_customer_idstring

Filter orders by their external customer id

created_at_gtstring date

Get orders with a created_at date that is bigger then the one provided

created_at_ltstring date

Get orders with a created_at date that is smaller then the one provided

Response

A list of orders

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

idstring uuid required

identifier of a previously created order

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.