POST POS/PurchaseOrders/Search Try Now

Search the purchase order.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

The request.

NameDescriptionTypeAdditional information
PONumber
Purchase order number.
long
None.
ExternalOrderNumber
External order number.
string
None.
CustomerId
Customer identifier.
string
None.
Email
Email.
string
None.
Company
Company.
string
None.
ShippingStatus
Shipping status.
Collection of ShippingStatus
None.
PaymentStatus
Payment status.
Collection of PaymentStatus
None.
PurchaseOrderStatus
Purchase order status.
Collection of PurchaseOrderStatus
None.
POType
Type of PO.
Collection of POType
None.
PurchaseOrderDate
PO date.
DateValue
None.
TicketGroupId
Ticket group identifier.
string
None.
PurchaseOrderId
Purchase order identifier.
string
None.
InvoiceId
Invoice identifier.
string
None.
Tags
Collection of string
None.
OrderBy
Sets the order by.(Note: Please use column Name Given in Response only,Don't use "Page" or "ItemsPerPage").
string
None.
SortOrder
The SortOrder i.e. "ASC" or "DESC"
string
None.
DateUpdated
Set Date Updated you can use either Date Updated Or UpdatedSince.
date
None.
UpdatedSince
Set From Date and To Date value. Return result for between date , From Date And To Date.
DateValue
None.
Page
Sets the page.
integer
None.
ItemsPerPage
Sets the items per page.
integer
None.

Request Formats

application/json, text/json

Sample:
{
  "PONumber": 1,
  "ExternalOrderNumber": "",
  "CustomerId": "",
  "Email": "",
  "Company": "",
  "ShippingStatus": [
    "Any"
  ],
  "PaymentStatus": [
    "Any"
  ],
  "PurchaseOrderStatus": [
    "Any"
  ],
  "POType": [
    "Any"
  ],
  "PurchaseOrderDate": {
    "FromDate": "2019-10-18T16:33",
    "ToDate": "2019-10-18T16:34",
    "FilterByTime": true
  },
  "TicketGroupId": "",
  "PurchaseOrderId": "",
  "InvoiceId": "",
  "Tags": [
    ""
  ],
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-10-18T16:33",
  "UpdatedSince": {
    "FromDate": "2019-10-18T16:33",
    "ToDate": "2019-10-18T16:34",
    "FilterByTime": true
  },
  "Page": 12,
  "ItemsPerPage": 13
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
Items
Collection of SearchPOResponse
None.
Page
integer
None.
TotalPages
integer
None.
Records
integer
None.
Meta
Object
None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "PurchaseOrderId": "",
      "PONumber": 2,
      "PurchaseOrderDate": "2019-10-18T16:33",
      "POStatus": "Any",
      "POType": "Any",
      "ExternalOrderNumber": "",
      "CustomerId": "",
      "Company": "",
      "Email": "",
      "PaymentStatus": "Any",
      "SubTotal": {
        "Currency": "",
        "Amount": 1.0
      },
      "GrandTotal": {
        "Currency": "",
        "Amount": 1.0
      },
      "BalanceAmount": {
        "Currency": "",
        "Amount": 1.0
      },
      "ShippingCost": {
        "Currency": "",
        "Amount": 1.0
      },
      "DateExpected": "2019-10-18T16:33",
      "DateReceived": "2019-10-18T16:33",
      "DateUpdated": "2019-10-18T16:33",
      "ShippingDetails": {
        "Status": "Any",
        "Type": "None",
        "Carrier": "None",
        "Service": "",
        "TrackingNumber": ""
      },
      "Notes": "",
      "VoidReason": "",
      "Consignment": {
        "Operation": "Any",
        "Commission": 1.0
      },
      "Version": 13,
      "Phone": "",
      "Tags": [
        ""
      ]
    }
  ],
  "Page": 1,
  "TotalPages": 2,
  "Records": 3,
  "Meta": {}
}