Get Custom Columns

Updated 2 months ago ​by nussi

Overview

In order to get information for custom columns of a single order, 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 on the call for receiving a single order.

  • Have valid ID of an existing order

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/orders/customcolumns?id={order_id}

For your server endpoint will be:

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

Request

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

Parameter

Data Type

Description

Is Required

id

integer

ID of existing sales order

true

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

Response

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

{
  "ID": 1,
  "ColumnName": "OrderQty",
  "DisplayName" "Order Qty",
  "DataType": 1,
  "DataLength": 12,
  "IsDropdownColumn": 0,
  "IsDropDownCustomTextAllowed": 0,
  "Value": 2
}

DataType field represents type of the custom column.

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

How did we do?