---
title: "List in-person orders"
method: GET
path: "/in-person/orders"
tags: ["In-Person Orders"]
---

# List in-person orders

`GET /in-person/orders`

Fetches an paginated list of in-person orders

## Query parameters

- `ascending` boolean
- `limit` integer
- `startsAfter` string

## Headers

- `Account` string

## Response `200`

The resource was retrieved successfully

- InPersonOrders
  - `items` InPersonOrder[]
    - `id` string — The Id of the order
    - `status` 'AwaitingPayment' | 'ReadyToShip' | 'Shipped' | 'Cancelled'
    - `totalAmount` integer — The total amount (in minor units) of the order, inclusive of tax
    - `taxAmount` integer — The total amount of tax (in minor units) paid on the order
    - `currency` string — The ISO currency code
    - `items` InPersonOrderItem[]
      - `id` string — The ID of the corresponding `InPersonProductSku`
      - `name` string — The name of the corresponding SKU
      - `totalAmountPerUnit` integer — The total amount (in minor units) per unit of this SKU, inclusive of tax
      - `taxAmountPerUnit` integer — The amount of tax (in minor units) per unit of this SKU.
      - `quantity` integer — The number of the given SKU to purchase on the order
    - `shipping` object, nullable — The shipping address, contact info & method used
      - `address` object, nullable
        - `businessName` string, nullable — The name of the business at this address
        - `firstName` string — The first name of the customer
        - `lastName` string — The last name of the customer
        - `lineOne` string — First line of the address
        - `lineTwo` string, nullable — Second line of the address
        - `city` string — The address city/town
        - `country` string — The two-character ISO country code
        - `postalCode` string — The postal code/zip of the address
        - `region` string, nullable — The state/county/province/region Required if the address is in the US/Canada and must be a 2-character ISO state/province code
        - `deliveryInstructions` string, nullable — Any delivery instructions
      - `contact` object, nullable
        - `email` string — The email address to contact regarding shipping updates.
        - `mobilePhoneNumber` string — The mobile phone number to contact regarding shipping updates. Must be in E.164 format!
      - `method` object, nullable
        - `id` string — The Id of the shipping method
        - `name` string — The name of the shipping method that was used
        - `description` string — A description of this shipping method
        - `totalAmount` integer — The total amount (in minor units) that was charged for this shipping method, inclusive of tax
        - `taxAmount` integer — The amount of tax (in minor units) included in the 'totalAmount'
    - `tracking` InPersonOrderTracking — Tracking details for the order. Available once it has been shipped.
      - `items` InPersonOrderTrackingItem[]
        - `carrier` string — The name of the carrier who will deliver this shipment
        - `reference` string — The tracking reference for this shipment
        - `shippedTimestamp` integer — The epoch timestamp (seconds) when this shipment was shipped
    - `metadata` object — 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.
    - `createdTimestamp` integer — The epoch timestamp (seconds) when the object was created
    - `lastUpdatedTimestamp` integer — The epoch timestamp (seconds) when the object was last updated
  - `paginationToken` string, nullable — A token to use for getting the next page of results - send the same request with this value in the 'paginationToken' query parameter. This field is null when there are no further items to return

## Other responses

- `400` — One or more inputs are invalid
- `403` — You do not have access to this resource
- `500` — An unexpected error occurred when executing this request

---

[API](https://skmtc.net/ryftpay/apis/ryft-payment-api.md) · [All operations](https://skmtc.net/ryftpay/apis/ryft-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ryftpay/ryft-payment-api/revisions/778890ee7e72/schema)