Get Custom Columns - Sellercloud API Docs

Overview

In order to get information for custom columns of a PO, you can consume the endpoint presented in this article. In order to consume it, 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 service call.

• Have valid ID of an PO

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/PurchaseOrders/CustomColumns?id={id}

For your server endpoint will be:

​ https://{your_server_id}.api.sellercloud.com/rest/api/PurchaseOrders/id={id}

Request

• Method Type: HttpGet
• Authorization: Use Bearer Token + token received from token authentication
• Header info: Content-Type: application/json
• Parameters: ID of the PO

Example: https://tt.api.sellercloud.com/rest/api/purchaseorders/customcolumns?id=1

Response

• If user is authenticated and provides a valid ID of an PO, then response will be Status Code 200 => OK and PO custom columns information 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 Format

{
  "ColumnName": "PoQty",
  "DisplayName": "Po Qty",
  "Value": 2
}

DataType field represents type of the custom column.

String = 0,
Integer = 1,
Decimal = 2,
DateTime = 3,
Boolean = 4,
nText = 5,
Hyperlink = 6