GET v3/orders?filter={filter}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filter

string

Required

Body Parameters

None.

Response Information

Resource Description

AppAltOrderListResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

Collection of AppAltOrderDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": [
    {
      "id": 1,
      "customerId": "sample string 2",
      "urlCode": "sample string 3",
      "number": 4,
      "status": "sample string 5",
      "createdDate": "2022-09-30T04:32:28.7443161-06:00",
      "paidDate": "2022-09-30T04:32:28.7443161-06:00",
      "paymentMethod": "sample string 7",
      "paymentStatus": "sample string 8",
      "createdBy": "sample string 9",
      "currency": "sample string 10",
      "total": 11.0,
      "seen": true,
      "customerName": "sample string 13",
      "customerEmail": "sample string 14",
      "customerDocumentId": "sample string 15",
      "deliveryMethod": "sample string 16",
      "deliveryCompany": "sample string 17",
      "deliveryLocation": "sample string 18",
      "deliveryTracking": "sample string 19",
      "couponName": "sample string 20",
      "transactionId": "sample string 21",
      "lastFourDigits": "sample string 22"
    },
    {
      "id": 1,
      "customerId": "sample string 2",
      "urlCode": "sample string 3",
      "number": 4,
      "status": "sample string 5",
      "createdDate": "2022-09-30T04:32:28.7443161-06:00",
      "paidDate": "2022-09-30T04:32:28.7443161-06:00",
      "paymentMethod": "sample string 7",
      "paymentStatus": "sample string 8",
      "createdBy": "sample string 9",
      "currency": "sample string 10",
      "total": 11.0,
      "seen": true,
      "customerName": "sample string 13",
      "customerEmail": "sample string 14",
      "customerDocumentId": "sample string 15",
      "deliveryMethod": "sample string 16",
      "deliveryCompany": "sample string 17",
      "deliveryLocation": "sample string 18",
      "deliveryTracking": "sample string 19",
      "couponName": "sample string 20",
      "transactionId": "sample string 21",
      "lastFourDigits": "sample string 22"
    }
  ]
}

application/xml, text/xml

Sample:
<AppAltOrderListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <AppAltOrderDTO>
      <couponName>sample string 20</couponName>
      <createdBy>sample string 9</createdBy>
      <createdDate>2022-09-30T04:32:28.7443161-06:00</createdDate>
      <currency>sample string 10</currency>
      <customerDocumentId>sample string 15</customerDocumentId>
      <customerEmail>sample string 14</customerEmail>
      <customerId>sample string 2</customerId>
      <customerName>sample string 13</customerName>
      <deliveryCompany>sample string 17</deliveryCompany>
      <deliveryLocation>sample string 18</deliveryLocation>
      <deliveryMethod>sample string 16</deliveryMethod>
      <deliveryTracking>sample string 19</deliveryTracking>
      <id>1</id>
      <lastFourDigits>sample string 22</lastFourDigits>
      <number>4</number>
      <paidDate>2022-09-30T04:32:28.7443161-06:00</paidDate>
      <paymentMethod>sample string 7</paymentMethod>
      <paymentStatus>sample string 8</paymentStatus>
      <seen>true</seen>
      <status>sample string 5</status>
      <total>11</total>
      <transactionId>sample string 21</transactionId>
      <urlCode>sample string 3</urlCode>
    </AppAltOrderDTO>
    <AppAltOrderDTO>
      <couponName>sample string 20</couponName>
      <createdBy>sample string 9</createdBy>
      <createdDate>2022-09-30T04:32:28.7443161-06:00</createdDate>
      <currency>sample string 10</currency>
      <customerDocumentId>sample string 15</customerDocumentId>
      <customerEmail>sample string 14</customerEmail>
      <customerId>sample string 2</customerId>
      <customerName>sample string 13</customerName>
      <deliveryCompany>sample string 17</deliveryCompany>
      <deliveryLocation>sample string 18</deliveryLocation>
      <deliveryMethod>sample string 16</deliveryMethod>
      <deliveryTracking>sample string 19</deliveryTracking>
      <id>1</id>
      <lastFourDigits>sample string 22</lastFourDigits>
      <number>4</number>
      <paidDate>2022-09-30T04:32:28.7443161-06:00</paidDate>
      <paymentMethod>sample string 7</paymentMethod>
      <paymentStatus>sample string 8</paymentStatus>
      <seen>true</seen>
      <status>sample string 5</status>
      <total>11</total>
      <transactionId>sample string 21</transactionId>
      <urlCode>sample string 3</urlCode>
    </AppAltOrderDTO>
  </data>
  <isApproved>true</isApproved>
</AppAltOrderListResponse>