List cart payments

Request

Security

OAuth2(Required scopes: FullAccessShopper)

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Description"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"DateCreated""ID""Type""CreditCardID""SpendingAccountID""!DateCreated""!ID""!Type""!CreditCardID""!SpendingAccountID"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/cart/payments?search=string&searchOn=ID&sortBy=DateCreated&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(Payment)

Example:

[
  {
    "ID": "",
    "Type": "PurchaseOrder",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CreditCardID": "",
    "SpendingAccountID": "",
    "Description": "",
    "Currency": "",
    "Amount": 0,
    "Accepted": false,
    "OrderReturnID": "",
    "xp": {},
    "Transactions": [ … ]
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}