TAtangocard
7. Async Orders

Get an Async Order by external reference ID with cursor-based pagination.

Changed on
get/asyncOrders/customers/{customerIdentifier}/accounts/{accountIdentifier}/{externalRefID}

Request

  • Base URL
    https://integration-api.tangocard.com/raas/v2
  • URL
    https://integration-api.tangocard.com/raas/v2/asyncOrders/customers/{customerIdentifier}/accounts/{accountIdentifier}/{externalRefID}
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

customerIdentifierstring required

specify the customer to be queried

accountIdentifierstring required

Specify the account to be queried.

externalRefIDstring required

External reference ID of the async order

Query parameters

prevCursorstring

Cursor for navigating to previous page

nextCursorstring

Cursor for navigating to next page

maxResultsinteger

Maximum number of line items to return

externalRefLineItemIDsstring[]

Specify the externalRefLineItemIDs to be queried. A maximum of 50 externalRefLineItemIDs can be provided.

referenceLineItemIDsstring[]

Specify the referenceLineItemIDs to be queried. A maximum of 50 referenceLineItemIDs can be provided.

failedOnlyboolean

Specify true to return only failed line items

customFieldsobject

Filter by one or more custom fields. Add one entry per filter, using the fully qualified key with customFields prefix, e.g. key <code>customFields.employeeId</code> with value E123 produces <code>?customFields.employeeId=E123</code>. All supplied key/value pairs must match (AND logic).

Response

OK

referenceOrderIDstring

Internal reference order ID

externalRefIDstring

External reference ID provided by client

orderStatusstring

Current status of the order

createdAtstring date-time

Order creation timestamp

completedAtstring date-time

Order completion timestamp

customerIdentifierstring

Customer identifier

accountIdentifierstring

Account identifier

campaignstring

Campaign name

purchaseOrderNumberstring

Purchase order number

notesstring

Order notes

totalLineItemsinteger

Total number of line items

Changes

  • 04d5b0da2197Revision changes
    • info

      added the new optional query request parameter customFields

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status