Overview
This endpoint can be used to get purchase orders using a saved view.
In order to consume the endpoint, you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed to the call.
Endpoint
https://{your_server_id}.api.sellercloud.com/rest/api/PurchaseOrders/GetAllByView
Request
Method Type: HttpGet
Authorization: Use Bearer Token + token received from token authentication
Header info: Content-Type: application/json
List of query parameters:
| Parameter | Data Type | Description | Required |
| ViewID | Integer | The ID of existing PO saved view | Yes |
| PageNumber | Integer | Page number | Yes |
| PageSize | Integer | Page size
Maximum page size is 50. If greater value is provided 50 records will be returned per page. |
Yes |
Response
- If the user is authenticated and the request is successful, then the response will be Status Code 200 => OKwith the found purchase orders in the response body
- If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token
- In case of an error, the response will be Status Code 500 => Internal Server Error
- In case of an incorrect request, the response will be with status code 400 Bad Request
Response Body
{
"Items": [
{
"Items": [
{
"EmailSentCount": 0,
"DisableInventoryCount": true,
"POType": 0,
"CancelledPOID": 0,
"TotalBalance": 0,
"TotalBalanceNotReceivedGood": 0,
"VendorID": 0,
"PurchaseTitle": "string",
"CreatedOn": "2024-01-05T15:32:08.007Z",
"CreatedBy": 0,
"OrderTotal": 0,
"TaxTotal": 0,
"ShippingTotal": 0,
"GrandTotal": 0,
"DateOrdered": "2024-01-05T15:32:08.007Z",
"LastRevisedOn": "2024-01-05T15:32:08.007Z",
"RevisedBy": 0,
"PurchaseOrderStatus": 0,
"PaymentStatus": 0,
"ExtraCharges": 0,
"TotalRefunded": 0,
"PurchaseOrdersShippingStatus": 0,
"TrackingNumber": "string",
"TrackingNumbers": [
{
"ShippedOn": "2024-01-05T15:32:08.007Z",
"ShippingCarrier": "string",
"TrackingNumber": "string"
}
],
"ShippedOn": "2024-01-05T15:32:08.007Z",
"CourierService": "string",
"PurchaseOrdersPriority": 0,
"ReceivingStatus": 0,
"CompanyID": 0,
"PurchaseOrdersApproved": true,
"DropShipOrderNumber": 0,
"VendorInvoiceNumber": "string",
"VendorInvoiceFileName": "string",
"VendorInvoiceFileNameOriginal": "string",
"Invoices": [
{
"InvoiceNumber": "string"
}
],
"Memo": "string",
"ExpectedDeliveryDate": "2024-01-05T15:32:08.007Z",
"DiscountTotal": 0,
"bExported": true,
"DisplayName": "string",
"CM": 0,
"NotesCount": 0,
"PaidOn": "2024-01-05T15:32:08.007Z",
"UnitCounts": 0,
"PurchaseOrderCreditMemo": true,
"WarehouseID": 0,
"Items": [
{
"ID": 0,
"SKU": "string",
"VendorSKU": "string",
"ProductName": "string",
"QtyOrdered": 0,
"QtyReceived": 0,
"UnitPrice": 0,
"AdjustedPrice": 0,
"LineTotal": 0,
"ExpectedDeliveryDate": "2024-01-05T15:32:08.007Z",
"ItemNotes": "string"
}
],
"RequestedShippingCarrier": "string",
"RequestedShippingService": "string",
"ShipToAddress": {
"ClientID": 0,
"UserID": 0,
"HomePhoneExt": "string",
"PhoneNumberExt": "string",
"IsShippingAddress": true,
"IsBillingAddress": true,
"AddressClassification": 0,
"Notes": "string",
"HomePhone": "string",
"EmailAddress": "string",
"AddressStatus": 0,
"AddressSource": 0,
"ID": 0,
"FirstName": "string",
"MiddleInitial": "string",
"LastName": "string",
"CompanyName": "string",
"StreetLine1": "string",
"StreetLine2": "string",
"City": "string",
"StateName": "string",
"StateCode": "string",
"PostalCode": "string",
"CountryName": "string",
"CountryCode": "string",
"PhoneNumber": "string",
"FaxNumber": "string",
"WebSiteURL": "string"
},
"ID": 0
}
],
"TotalResults": 0
}
],
"TotalResults": 0
}