Get Custom Columns for Orders in Bulk

Overview

In order to get information on custom columns for multiple orders, 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 an list of valid order IDs

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Orders/GetCustomColumns

For your server endpoint will be:

​https://{your_server_id}.api.sellercloud.com/rest/api/Orders/GetCustomColumns

Request

• Method Type: HttpPost
• Authorization: Use Bearer Token + token received from token authentication
• Header info: Content-Type: application/json
• Parameters: List of Order IDs

Parameter	Data Type	Description	Is Required
OrderIDs	List	List of Order IDs	true

 

Response

• If user is authenticated and provides a list of Valid Order IDs, then response will be Status Code 200 => OK and an object which will contain the OrderID and a collection containing all of the custom columns 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

 {
    "OrderID": 0,
    "CustomColumns": [
        {
        "ID": 0,
        "ColumnName": "ColumnName",
        "DisplayName": "DisplayName",
        "DataType": 0,
        "DataLength": 0,
        "IsDropDownColumn": true,
        "IsDropDownCustomTextAllowed": true,
        "Value": {}
        }
    ]
}

DataType field represents type of the custom column.

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