Update Container Custom Columns

Overview

You can use this endpoint to update the values of one or multiple existing custom columns for a single Shipping Container. In order to do that, you must:

  • Be an authenticated user

For information on how you can authenticate, see: Authentication.

Endpoint

An example of such an endpoint for server XX is:

https://xx.api.sellercloud.com/api/ShippingContainers/{id}/CustomColumns

For your server, the endpoint will be:

https://{your_server_id}.api.sellercloud.com/api/ShippingContainers/{id}/CustomColumns

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Request Parameter: Valid ID of an existing Shipping Container.
  • Body data – a list of Custom Columns:
    Parameter Data Type Description Is Required
    ColumnName string Name of the existing column. This is not the display name seen in the UI. This should be the Column Name instead. Yes
    Value string The new value of the custom column. Writing “” will remove the existing value. Providing Null will return an error. Yes

Request Body

{
  "CustomColumns": [
    {
      "ColumnName": "string",
      "Value": {}
    }
  ]
}

Response

  • If a server error appears, then the response will be with status code 500 => Internal Server Error.
  • If updating the value of the custom column is successful, the status code will be OK 200.

Was this article helpful?