Documentation Index
Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
Use this file to discover all available pages before exploring further.
Methods
Entity Properties
Additional Resources
order_custom_field.list
order_custom_field.list()
Retrieve list of order custom fields available for the calling merchant.
Return Value
An array of objects. Each object will contain Order Custom Field properties.
Example Request
{
"jsonrpc" : 2.0,
"id" : 1234,
"method" : "call",
"params" : [
"34aa989befe360d67fe3f70b3517a1e5",
"order_custom_field.list"
]
}
Example 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",
"is_display_client_grid": "1",
"is_display_client_form": "0",
"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",
"is_display_client_grid": "0",
"is_display_client_form": "1",
"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
Order Custom Field Properties
Show Order Custom Field Properties
An automatically generated unique identifier for an Order Custom Field.
Flag whether Order Custom Field is active.
The “input_type” property. Allowed values: “text”, “multiline-text”, “number”, “currency”, “select”, “multiselect”, “boolean”, “date”, “client-user”, “admin-user”, “email”, “url”.
Flag whether Order Custom Field is required.
The “client_note” property.
The “unrestricted” property. Allowed values: “unrestricted”, “restricted”, “read-only”, “hidden”.
Flag whether Order Custom Field is displayed in the client grid.
Flag whether Order Custom Field is displayed in the client form.
The “sort_order” property.
The “Created At” property.
The “Updated At” property.
Order Custom Field Option Properties
Show Order Custom Field Option Properties
Flag whether option is default.
The “Sort Order” property.
