---
title: "Get a list of Orders placed under this Platform."
method: GET
path: "/orders"
tags: ["6. Orders"]
---

# Get a list of Orders placed under this Platform.

`GET /orders`

## Query parameters

- `accountIdentifier` string
- `customerIdentifier` string
- `externalRefID` string
- `startDate` string
- `endDate` string
- `elementsPerBlock` integer
- `page` integer
- `minAmount` number
- `maxAmount` number
- `currencyCode` string
- `utid` string
- `ptid` string
- `rewardName` string
- `senderFirstName` string
- `senderLastName` string
- `senderEmail` string
- `recipientEmail` string
- `recipientMobileNumber` string
- `recipientFirstName` string
- `recipientLastName` string
- `sendEmail` boolean
- `deliveryMethod` 'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'BULKSHIPMENT' | 'QRCODE' | 'BULKDIGITAL' | 'EMBEDDED_COMPONENT' | 'WHATSAPP'
- `status` 'PENDING' | 'QUEUED' | 'PENDING_MR' | 'ON_HOLD' | 'CANCELLED' | 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'DELETED' | 'PENDING_KYB' | 'PENDING_PAYMENT'
- `orderStatus` 'PENDING' | 'QUEUED' | 'PENDING_MR' | 'ON_HOLD' | 'CANCELLED' | 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'DELETED' | 'PENDING_KYB' | 'PENDING_PAYMENT'
- `lineItemStatus` 'COMPLETE' | 'PENDING' | 'FAILED' | 'DELETED' | 'CANCELLED' | 'RETURNED'
- `campaign` string
- `notes` string
- `lineItemNotes` string
- `purchaseOrderNumber` string

## Response `200`

OK

- OrderListView
  - `page` PageView, required
    - `number` integer, required
    - `elementsPerBlock` integer, required
    - `resultCount` integer, required
    - `totalCount` integer, required
  - `orders` OrderListItemView[], required
    - `referenceOrderID` string, required
    - `externalRefID` string
    - `customerIdentifier` string, required
    - `accountIdentifier` string, required
    - `accountNumber` string, required
    - `amountCharged` MoneyView, required
      - `value` number
      - `currencyCode` string
      - `exchangeRate` number
      - `fee` number
      - `total` number
    - `denomination` MoneyView
      - `value` number
      - `currencyCode` string
      - `exchangeRate` number
      - `fee` number
      - `total` number
    - `utid` string, required
    - `ptid` string
    - `rewardName` string, required
    - `sender` SenderInfoView
      - `firstName` string
      - `lastName` string
      - `email` string
    - `recipient` RecipientInfoView
      - `firstName` string
      - `lastName` string
      - `email` string
      - `mobileNumber` string
      - `address` RecipientAddressView
        - `companyName` string
        - `streetLine1` string
        - `streetLine2` string
        - `city` string
        - `stateOrProvince` string
        - `postalCode` string
        - `country` string
    - `emailSubject` string, required
    - `message` string, required
    - `sendEmail` boolean
    - `deliveryMethod` 'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'BULKSHIPMENT' | 'QRCODE' | 'BULKDIGITAL' | 'EMBEDDED_COMPONENT' | 'WHATSAPP'
    - `etid` string, required
    - `status` string, required
    - `orderStatus` string
    - `lineItemStatus` string
    - `campaign` string, required
    - `createdAt` string, required
    - `notes` string
    - `orderClientSource` string
    - `purchaseOrderNumber` string
    - `orderExternalRefIdDupe` boolean
    - `asyncOrderEntity` AsyncOrderEntity
      - `externalRefID` string — Required. Idempotent field that can be used for client-side order cross reference and prevent accidental order duplication. Will be returned in order response.
      - `status` string — This status reflects about cart status or validation status based on the processing
      - `totalLineItems` integer — Total number of line items submitted in the request
      - `createdAt` string, date-time
      - `failedLineItems` LineItemError[] — Failed line items list (business validations)
        - `lineItemId` string
        - `externalRefLineItemID` string
        - `utid` string
        - `errors` ValidationErrorDto[]
          - `field` string
          - `errorCodeValue` integer
          - `errorCodeName` string
          - `message` string
      - `duplicateLineItemRefIds` object — If any duplicate duplicateLineItemRefIds exist in the request

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tangocard/apis/tango-api.md) · [All operations](https://skmtc.net/tangocard/apis/tango-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tangocard/tango-api/revisions/324ad9683921/schema)