POST Orders/Payments

Get all the Payments

Request Information

URI Parameters

None.

Body Parameters

GetPaymentsRequest
NameDescriptionTypeAdditional information
Filter

PaymentFilter

None.

Range

AdminFilterRange

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentsView
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Payments

Collection of Payment

None.

FilterableProperties

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "Payments": [
    {
      "ID": 1,
      "OrderID": 2,
      "Date": "2025-12-06T05:42:10.6361355+01:00",
      "MeansID": 4,
      "Amount": 5.0,
      "TransactionId": "sample string 6",
      "TransactionStatus": "sample string 7",
      "Observations": "sample string 8"
    },
    {
      "ID": 1,
      "OrderID": 2,
      "Date": "2025-12-06T05:42:10.6361355+01:00",
      "MeansID": 4,
      "Amount": 5.0,
      "TransactionId": "sample string 6",
      "TransactionStatus": "sample string 7",
      "Observations": "sample string 8"
    }
  ],
  "FilterableProperties": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PaymentsView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <FilterableProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Services.Views">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FilterableProperties>
  <Payments>
    <Payment>
      <Amount>5</Amount>
      <Date>2025-12-06T05:42:10.6361355+01:00</Date>
      <ID>1</ID>
      <MeansID>4</MeansID>
      <Observations>sample string 8</Observations>
      <OrderID>2</OrderID>
      <TransactionId>sample string 6</TransactionId>
      <TransactionStatus>sample string 7</TransactionStatus>
    </Payment>
    <Payment>
      <Amount>5</Amount>
      <Date>2025-12-06T05:42:10.6361355+01:00</Date>
      <ID>1</ID>
      <MeansID>4</MeansID>
      <Observations>sample string 8</Observations>
      <OrderID>2</OrderID>
      <TransactionId>sample string 6</TransactionId>
      <TransactionStatus>sample string 7</TransactionStatus>
    </Payment>
  </Payments>
  <TotalCount>1</TotalCount>
</PaymentsView>