v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

In-Person Orders

Retrieve an in-person order

Fetches an in-person order via its unique ID

get/in-person/orders/{id}

Path parameters

idstring required

Example:ipord_01FCTS1XMKH9FF43CAFA4CXT3P

the unique ID of the order

Headers

Accountstring

Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this when you want to fetch an in person order under a linked account)

Response

The resource was retrieved successfully

idstring

The Id of the order

status'AwaitingPayment' | 'ReadyToShip' | 'Shipped' | 'Cancelled'

totalAmountinteger

The total amount (in minor units) of the order, inclusive of tax

taxAmountinteger

The total amount of tax (in minor units) paid on the order

currencystring

The ISO currency code

metadataobject

Your own custom key-value data for this object. These will be sent with any associated events on your webhooks. You can have a maximum of 5 pieces of metadata.

Keys must be between 1 and 30 characters in length.

Values must be between 1 and 250 characters in length.

createdTimestampinteger

The epoch timestamp (seconds) when the object was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the object was last updated

Example response

{
  "id": "ipord_01FCTS1XMKH9FF43CAFA4CXT3P",
  "status": "AwaitingPayment",
  "totalAmount": 6000,
  "taxAmount": 1000,
  "currency": "GBP",
  "items": [
    {
      "id": "ipsku_01FCTS1XMKH9FF43CAFA4CXT3P",
      "name": "Pax A920 Pro",
      "totalAmountPerUnit": 100,
      "taxAmountPerUnit": 20,
      "quantity": 10
    }
  ],
  "shipping": {
    "address": {
      "businessName": "Ryft Computer Parts",
      "firstName": "Jeff",
      "lastName": "Bridges",
      "lineOne": "123 Test Street",
      "lineTwo": "456 Test Lane",
      "city": "Manchester",
      "country": "GB",
      "postalCode": "M3 3AG",
      "region": "Greater Manchester",
      "deliveryInstructions": "Deliver to the Goods In entrance at the back of the building"
    },
    "contact": {
      "email": "example@mail.com",
      "mobilePhoneNumber": "+447900000000"
    },
    "method": {
      "id": "ipsm_01FCTS1XMKH9FF43CAFA4CXT3P",
      "name": "Next Business Day",
      "description": "If placed before 9pm, this order will be shipped on the next business day.",
      "totalAmount": 1500,
      "taxAmount": 100
    }
  },
  "tracking": {
    "items": [
      {
        "carrier": "DHL",
        "reference": "2505080829",
        "shippedTimestamp": 1470989538
      }
    ]
  },
  "metadata": {
    "orderId": "1",
    "customerId": "123"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}