Get All Purchase Orders

Overview

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

  • Be authenticated user

Information how you can authenticate can take from: 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/purchaseorder/getall?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<integer>

List of IDs of purchase orders

no

companyIDList

List<integer>

List of IDs of companies

no

pOStatuses

List<string>

Saved,Ordered,Received, Pending,Cancelled, Competed.

no

shippingStatuses

List<string>

None, PartiallyShipped,FullyShipped

no

receivedStatuses

List<string>

None, PartiallyReceived, FullyReceived

no

createDateFrom

DateTime

Minimum creation date

no

createDateTo

DateTime

Maximum creation date

no

paymentStatus

List<string>

NoPayment, Authorized, Charged, Uncleared, PartiallyRefund, eBayPaid, PaymentError

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
{ 
"Items": [],
TotalResults: 0
}
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error


How did we do?