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:
Parameters Data Type Description Is Required
pageNumber integer Number of page no
pageSize integer Number of purchase orders per page no
pOIDs List List of IDs of purchase orders no
companyIDList List List of IDs of companies no
pOStatuses List Saved,Ordered,Received, Pending,Cancelled, Competed. no
shippingStatuses List None, PartiallyShipped,FullyShipped no
receivedStatuses List None, PartiallyReceived, FullyReceived no
createDateFrom DateTime Minimum creation date no
createDateTo DateTime Maximum creation date no
paymentStatus List NoPayment, Authorized, Charged, Uncleared, PartiallyRefund, eBayPaid, PaymentError

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

no
inventoryCountEnabled int? Is Inventory Count Enabled

0: No, 1: Yes

no
vendorInvoiced VendorInvoicedStatus? Is Vendor Invoiced . This filter should only be utilized if client setting “Enable vendor invoices workflow” is enabled. no
approved int? Is Approved, 0: No, 1: Yes no
keyword string A search term for performing a global search. No no

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?

Related Articles