Get All Purchase Orders

Overview

In order to retrieve metadata for existing purchase orders, you must:

  • Be authenticated user

Information on how you can authenticate: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call for getting purchase orders.

You can do additional filtering and pagination on the purchase orders.

Endpoint

Example for such endpoint for TT server: https://tt.api.sellercloud.com/rest/api/purchaseorders?pageNumber=1&pageSize=1

Request

Information about expected request parameters and their type can be found on swagger UI https://tt.api.sellercloud.com/rest/swagger.

 

  • Method Type: HttpGet
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters:
ParametersData TypeDescriptionIs Required
pageNumberintegerNumber of pageno
pageSizeintegerNumber of purchase orders per pageno
pOIDsListList of IDs of purchase ordersno
companyIDListListList of IDs of companiesno
pOStatusesListSaved,Ordered,Received, Pending,Cancelled, Competed.no
receivingWarehouseIDListList of receiving warehouse IDsno
shippingStatusesListNone, PartiallyShipped,FullyShippedno
receivedStatusesListNone, PartiallyReceived, FullyReceivedno
createDateFromDateTimeMinimum creation dateno
createDateToDateTimeMaximum creation dateno
paymentStatusListNoPayment, Authorized, Charged, Uncleared, PartiallyRefund, eBayPaid, PaymentError

Important: That filter should only be utilized if client setting “Enable vendor invoices workflow” is disabled.

no
inventoryCountEnabledint?Is Inventory Count Enabled

0: No, 1: Yes

no
vendorInvoicedVendorInvoicedStatus?Is Vendor Invoiced . This filter should only be utilized if client setting “Enable vendor invoices workflow” is enabled.no
approvedint?Is Approved, 0: No, 1: Yesno
keywordstringA search term for performing a global search. Nono

Response

  • If user is authenticated and provides a valid token, then response will be Status Code 200 => OK and purchase order metadata in JSON format
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

Response Body Format

Was this article helpful?

Next
Get Inventory Info for Multiple Products