Shipment Custom Fields

Methods

shipment_custom_field.list

Entity Properties

Shipment Custom Field
Shipment Custom Field Option

Additional Resources

Shipment Custom Fields — when updating Shipment info.

`shipment_custom_field.list`

shipment_custom_field.list() Retrieve list of shipment custom fields available for the calling merchant.

Return Value

An array of objects. Each object will contain Shipment Custom Field properties.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id"      : 1234,
    "method"  : "call",
    "params"  : [
        "34aa989befe360d67fe3f70b3517a1e5",
        "shipment_custom_field.list"
    ]
}

Example Response

Response

{
    "result": [
        {
            "custom_field_id": "3",
            "name": "Original Purchase Date",
            "code": "purchase_date",
            "is_active": "1",
            "input_type": "date",
            "is_required": "0",
            "client_note": null,
            "client_permissions": "restricted",
            "display_client_grid": "parcel,freight",
            "display_client_form": "parcel,freight",
            "export_client_grid": "parcel,freight",
            "sort_order": "0",
            "created_at": "2022-07-01T10:46:16+00:00",
            "updated_at": "2022-07-01T10:46:16+00:00"
        },
        {
            "custom_field_id": "4",
            "name": "Main Item SKU",
            "code": "main_sku",
            "is_active": "1",
            "input_type": "text",
            "is_required": "0",
            "client_note": null,
            "client_permissions": "unrestricted",
            "display_client_grid": "parcel",
            "display_client_form": "parcel",
            "export_client_grid": "parcel",
            "sort_order": "99",
            "created_at": "2022-07-01T11:43:28+00:00",
            "updated_at": "2022-07-01T11:43:28+00:00"
        }
    ],
    "id": "1234",
    "jsonrpc": "2.0"
}

Entity Properties

Shipment Custom Field Properties

Show Shipment Custom Field Properties

integer

An automatically generated unique identifier for an Shipment Custom Field.

string

The “name” property.

string

The “code” property.

integer

Flag whether Shipment Custom Field is active.

string

The “input_type” property. Allowed values: “text”, “multiline-text”, “number”, “currency”, “select”, “multiselect”, “boolean”, “date”, “client-user”, “admin-user”, “email”, “url”.

integer

Flag whether Shipment Custom Field is required.

string

The “client_note” property.

string

The “unrestricted” property. Allowed values: “unrestricted”, “restricted”, “read-only”, “hidden”.

string

Determine in which client grid the Shipment Custom Field is displayed. Possible values include: “parcel,” “freight,” “parcel,freight,” or an empty string "".

string

Determine in which client form the Shipment Custom Field is displayed. Possible values include: “parcel,” “freight,” “parcel,freight,” or an empty string "".

string

Determine in which exported document the Shipment Custom Field is included. Possible values include: “parcel,” “freight,” “parcel,freight,” or an empty string "".

integer

The “sort_order” property.

string

The “Created At” property.

string

The “Updated At” property.

array

Array of options. See Option Properties.

Shipment Custom Field Option Properties

Show Shipment Custom Field Option Properties

integer

The internal option ID.

string

The “Label” property.

integer

Flag whether option is default.

integer

The “Sort Order” property.

Get Started

Common Features

Shipping

Receiving

Inventory

System

Methods

Entity Properties

Additional Resources

`shipment_custom_field.list`

Return Value

Example Request

Example Response

Entity Properties

Shipment Custom Field Properties

Shipment Custom Field Option Properties

​Methods

​Entity Properties

​Additional Resources

​shipment_custom_field.list

​Return Value

​Example Request

​Example Response

​Entity Properties

​Shipment Custom Field Properties

​Shipment Custom Field Option Properties

Methods

Entity Properties

Additional Resources

`shipment_custom_field.list`

Return Value

Example Request

Example Response

Entity Properties

Shipment Custom Field Properties

Shipment Custom Field Option Properties