Schemas
AssignAction
typeReassignAction
typeStartAction
typeRevertAction
typeOutboundOrderForceCompleteAction
typeAllocateBulkAction
typeBulkMoveStockAction
typeUpdateDetailsBulkAction
typePrintAction
typeUpdateToteAction
typeCompleteAction
typeOutboundOrderCompleteAction
typeOutboundActions
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type, details | |
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type | |
| type = object · requires: type |
TaskReference
idTypedTaskReference
idtypeCustomerReference
idnameName of the customer
Alternate identifiers. code is used after id when both are supplied.
enabledDecision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id | |
| type = object · requires: name | |
| type = object · requires: references |
idnameName of the customer
Alternate identifiers. code is used after id when both are supplied.
enabledTaskBase
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
OutboundOrderReferences
numericIdcustomerOrder reference specified by Customer
Properties
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
TaskStatisticMeasures
totalItemsTotal number of items in the task.
totalQuantityThe total of all requested quantities for each item in the task.
totalSkusTotal number of SKUs that all task's items have
OutboundStatus
WarehouseReference
idnameName of the warehouse (exactly as spelt in CartonCloud)
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id | |
| type = object · requires: name |
idnameName of the warehouse (exactly as spelt in CartonCloud)
ExternalMeta
Source
applicationApplication identifier for the source of the entity
TimestampObject
timeISO 8601 formatted timestamp
userUser who performed the action
OutboundOrder_Core
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Outbound order
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Contains information about size of the order.
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
versionExternal Metadata by a specific External meta key
sourceSource information for the entity
Map of timestamp entries for various lifecycle events
AssigneeReference
idnameCartonCloud account user name
TransportMethod
typeDelivery method type
requestedServiceRequested shipping service (for example Standard, Express, Overnight)
AddressReferences
numericIdcodeState
codeCode used to denote the state
nameName of the state
Country
iso2CodeISO 3166-1 alpha-2 country code (2 characters)
iso3CodeISO 3166-1 alpha-3 country code (3 characters)
nameCountry name
Address_Core
idFields uniquely identifying Address
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
companyNameName of the company. Required if contactName is not supplied.
contactNameContact person's name. Required if companyName is not supplied.
address1First line of street address. Required for a complete address.
address2Additional address information (for example unit, apartment, suite)
suburbSuburb
cityCity. Required for a complete address.
State, region, or prefecture. When both code and name are supplied, code is used first.
Validation is country-dependent. CartonCloud maintains a per-country list of valid zones
(address_zones).
When the resolved country has no configured zones (for example New Zealand), any state
value in the request is ignored and the address is not rejected for an unknown state code
(draft is not set for state alone).
When zones exist (for example Australia, United States), state.code or state.name must
match a configured zone or the request returns 422
(Invalid reference value at /state/code or /state/name).
postcodePost code (zip code)
Geographical Coordinates
enabledapproveddraftstarredphonePhone number. Must be a string of 0–64 characters.
emailEmail address. Must not start with a full stop, must not contain spaces, and must have
content on both sides of @.
Address_WithZones
idFields uniquely identifying Address
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
companyNameName of the company. Required if contactName is not supplied.
contactNameContact person's name. Required if companyName is not supplied.
address1First line of street address. Required for a complete address.
address2Additional address information (for example unit, apartment, suite)
suburbSuburb
cityCity. Required for a complete address.
State, region, or prefecture. When both code and name are supplied, code is used first.
Validation is country-dependent. CartonCloud maintains a per-country list of valid zones
(address_zones).
When the resolved country has no configured zones (for example New Zealand), any state
value in the request is ignored and the address is not rejected for an unknown state code
(draft is not set for state alone).
When zones exist (for example Australia, United States), state.code or state.name must
match a configured zone or the request returns 422
(Invalid reference value at /state/code or /state/name).
postcodePost code (zip code)
Geographical Coordinates
enabledapproveddraftstarredphonePhone number. Must be a string of 0–64 characters.
emailEmail address. Must not start with a full stop, must not contain spaces, and must have
content on both sides of @.
Address Zone Fields
Money
amountAmount for the field
currencyISO 4217 currency code. For entity-scoped monetary fields (consignments, invoices, charges, and similar), this is typically the organisation default currency, or the warehouse effective currency when the related entity belongs to a warehouse with a currency override. Client-supplied currencies apply only where the field documentation explicitly allows it (for example outbound order invoiceValue).
TransportPoint
How items are transferred to a customer.
SHIPPING— delivery using a shipping carrier (default)PICKUP— the customer collects from a warehouse or other location
requestedService is the requested carrier service (for example Standard, Express, Overnight).
Address with Zone details
requiredDateinstructionsCash on delivery amount. When currency is omitted, the effective currency for the
related warehouse is used (see Money in common schemas).
OutboundDetails_Core
allowSplittingIf set to true, the order can be split into multiple orders. This is useful when the order contains multiple items and some of them are not available for shipping Backordering project
Delivery Address and details
Delivery Address and details
Total expense charge for the order. Only present when the user can view charging information. Currency is the effective default for the order's warehouse.
Total income charge for the order. Only present when the user can view charging information. Currency is the effective default for the order's warehouse.
instructionsPacking instruction for the order
The total invoice value for the order. Clients may supply any valid ISO 4217 currency code.
When currency is omitted on create or update, the effective currency for the order's warehouse
is used (warehouse override when configured, otherwise the organisation default).
isAdjustmentWhether the order is an adjustment order.
urgentCarrierReference
idnameSupplier
idnameDeliveryRunReference
idnameName of the delivery run
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Carrier Reference
OutboundDetails_Lifecycle
allowSplittingIf set to true, the order can be split into multiple orders. This is useful when the order contains multiple items and some of them are not available for shipping Backordering project
Delivery Address and details
Delivery Address and details
Total expense charge for the order. Only present when the user can view charging information. Currency is the effective default for the order's warehouse.
Total income charge for the order. Only present when the user can view charging information. Currency is the effective default for the order's warehouse.
instructionsPacking instruction for the order
The total invoice value for the order. Clients may supply any valid ISO 4217 currency code.
When currency is omitted on create or update, the effective currency for the order's warehouse
is used (warehouse override when configured, otherwise the organisation default).
isAdjustmentWhether the order is an adjustment order.
urgentCarrier Reference
Supplier
labelsPrintedIdentifies a delivery run by id and optional name. May include the associated warehouse.
expectedShipDatehasUnassignedProductsDoes Sale Order has products that has not yet been assigned to a Stock item (POP)
Use in Pick To Tote flow to provide information about tote
LifecycleReference
idTaskLifecycleState
A map where the keys represent all possible actions for the current task status, along with additional information of whether each action is expected to be successful or not. NOTE This list of actions only includes actions provided by the lifecycle for the current task status. Documentation
OutboundLifecycleState
A map where the keys represent all possible actions for the current task status, along with additional information of whether each action is expected to be successful or not. NOTE This list of actions only includes actions provided by the lifecycle for the current task status. Documentation
automaticConsignmentGenerationhideUnverifiedConsignmentItemsOnPackScreenisCarrierRateSelectionEnabledOnPackScreenIndicates whether carrier rate selection is enabled for the Sale Order on pack screen.
OutboundOrder_Lifecycle
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Outbound order
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Contains information about size of the order.
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
versionExternal Metadata by a specific External meta key
sourceSource information for the entity
Map of timestamp entries for various lifecycle events
If Outbound is part of Pick To Tote task, it's reference will be provided here
Details specific for the Outbound Task object
BoltLog
idUUID of the retained Bolt execution log.
Error
messageUser readable description of the error. If supported should respond according to Accept-Language header.
typeOptional type. Used when clients need to customise behaviour based on specific error types.
fieldOptional json pointer if it was identified what field caused the error
Optional details about the error. Structure is defined by the error type.
Retained Bolt execution log. Present only when a log was retained and the caller may view it.
If Accept-ErrorInstructions header is supplied and supported by the endpoint, errors may contain additional instructions and error handling option. Should only be used when error resolution instructions and options can only be determined by the server due to complex or variable situation.
ErrorList
messageUser readable description of the error. If supported should respond according to Accept-Language header.
typeOptional type. Used when clients need to customise behaviour based on specific error types.
fieldOptional json pointer if it was identified what field caused the error
Optional details about the error. Structure is defined by the error type.
Retained Bolt execution log. Present only when a log was retained and the caller may view it.
If Accept-ErrorInstructions header is supplied and supported by the endpoint, errors may contain additional instructions and error handling option. Should only be used when error resolution instructions and options can only be determined by the server due to complex or variable situation.
ChargeClassCode
The entity type that a fee category or charge applies to.
ChargeClass
codeThe entity type that a fee category or charge applies to.
nameHuman-readable charge class display name.
defaultAccountThe default account associated with this charge class.
ChargeClassList
List of all charge classes with their code, display name, and default account.
codeThe entity type that a fee category or charge applies to.
nameHuman-readable charge class display name.
defaultAccountThe default account associated with this charge class.
ConsignmentReferences
numericIdcustomerCustomer reference
trackingTracking reference
ConsignmentStatus
UserReference
idnameName of the user
ConsignmentSource
ManifestReference
idRunsheetReference
idnameName of the run sheet
dateRun sheet date
ConsignmentTrackingDetails
companyNameShipping company name
urlTracking URL for the consignment
ConsignmentType
ConsignmentItemMeasures
quantityweightpalletsspacescubicConsignmentSubItems
idtypeConsignmentItem
idCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
typeConsignment
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCarrier bill this consignment is assigned to. Only present when the consignment has an assigned bill and the caller has VIEW_CHARGES permission.
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Fields uniquely identifying Consignment
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTagConsignmentCreateRequest
The customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Fields uniquely identifying Consignment
idBilling invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeCarrier bill this consignment is assigned to. Only present when the consignment has an assigned bill and the caller has VIEW_CHARGES permission.
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Identifies a user by id and display name.
External Metadata by a specific External meta key
sourceReference to the task (e.g. outbound order) that generated this consignment
areChargesEditableisGrouperrorCounthasChildrencreateDateDate of creation
lastModifiedDate of last modification
eTagPrimitiveValue
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = integer | |
| type = number | |
| type = boolean |
PatchOperationEntity
oppathJsonPatchOperationList
List of patch operations following the JSON Patch specification. See RFC 6902 - JSON Patch for the official documentation. (add, replace, remove operations are supported)
oppathJsonMergePatchObject
PackedStockProduct
idquantityPacked quantity for this outbound order item on the given Transport Item.
PackedStockByTransportItem
consignmentItemIdProducts packed within this Transport Item.
ConsignmentCarrierProviderRatesRequest
Packed quantities per Transport Item on the consignment in the path. May be [].
ConsignmentCarrierProviderRatesDetailsLog
idUUID of the retained get-rates Bolt execution log for this request.
ConsignmentCarrierProviderRatesDetails
Retained get-rates Bolt execution log reference. Present only when a log was retained for this request and the caller may view carrier provider Bolt execution logs.
CarrierProviderOwner
idtypenameCarrierProviderSummary
idnameDisplay name of the carrier provider.
Owner of the carrier provider (tenant or customer).
CarrierAccount
References for a carrier account.
References for a carrier account.
QuotedCarrierRateCharge
categoryCharge category name.
descriptionCharge description.
Line item price.
QuotedCarrierRateRateReference
idQuotedCarrierRateRateCardReference
idCarrierAccountService
nameReferences for a carrier service.
descriptionQuotedCarrierRate
Carrier account.
idTotal of income charges based on carrier rate after applying tenant configured charges.
Carrier provider summary.
A service provided by a carrier account.
defaultWhether this rate is the default selected rate
Expense charges breakdown based on price breakdown returned by the carrier provider, excluding GST. Omitted when there is no breakdown, or when charging information is hidden from the user.
Total of expenses (excluding GST), based on cost returned by the carrier provider. Returned when charging information is shown to the user, when there is an income charge error, or when incomeTotal is zero. Otherwise omitted.
hasIncomeChargeErrortrue when income charge calculation failed for this rate, or rate not found. Omitted when there is no income charge error. Returned for all users.
incomeChargeErrorHuman-readable error when a transport rate cannot be found or charge calculation fails. Omitted when there is no error, or when charging information is hidden from the user.
Consignment charges that make up incomeTotal after markups. Omitted when there is no breakdown, or when charging information is hidden from the user.
labelOptional descriptive label
predefinedPackageCodePredefined package code selected for this quoted rate when the quote used a carrier predefined package. When multiple items contribute codes, values are joined with a comma and space.
Matched transport rate associated with this quoted carrier rate. Omitted when user does not have EDIT_RATE_CARD authority.
Rate card associated with this quoted carrier rate. Omitted when user does not have EDIT_RATE_CARD authority.
ConsignmentCarrierProviderRatesSuccessItem
Carrier provider summary.
statusConsignmentCarrierProviderRatesError
typeError type constant
messageHuman-readable error message
ConsignmentCarrierProviderRatesErrorItem
Carrier provider summary.
statusError details when status is ERROR. Required when status is ERROR.
ConsignmentCarrierProviderRatesResponse
Active providers with quoted rates or error status.
Additional details regarding the rates request or response.
selectedRateIdConsignmentChargeFeeCategory
idUUID for the fee category. Either id or name is required when setting charges.
nameName for the fee category. Used to look up or create a fee category when id is omitted.
ConsignmentChargeModifier
keyUse fuelLevy for a fuel levy modifier.
descriptionpercentageRepresents a monetary value with amount and currency.
For most API fields, currency is the tenant organisation default currency (defaultCurrency on the tenant), unless the value is tied to a warehouse that has its own currency override configured. In that case, currency reflects the effective currency for that warehouse (warehouse override, otherwise organisation default).
Some fields (for example outbound order invoiceValue) may accept or return an explicit currency code supplied by the client and are not limited to the organisation default alone.
ConsignmentChargeInput
idUUID for the persisted charge. Present in responses after charges are written.
Fee category for a consignment charge line.
descriptionA description of the charge.
Represents a monetary value with amount and currency.
For most API fields, currency is the tenant organisation default currency (defaultCurrency on the tenant), unless the value is tied to a warehouse that has its own currency override configured. In that case, currency reflects the effective currency for that warehouse (warehouse override, otherwise organisation default).
Some fields (for example outbound order invoiceValue) may accept or return an explicit currency code supplied by the client and are not limited to the organisation default alone.
The fee after any modifiers have been applied.
Charge modifiers (for example fuel levy). Usually omitted when setting charges manually.
ConsignmentChargeList
idUUID for the persisted charge. Present in responses after charges are written.
Fee category for a consignment charge line.
descriptionA description of the charge.
Represents a monetary value with amount and currency.
For most API fields, currency is the tenant organisation default currency (defaultCurrency on the tenant), unless the value is tied to a warehouse that has its own currency override configured. In that case, currency reflects the effective currency for that warehouse (warehouse override, otherwise organisation default).
Some fields (for example outbound order invoiceValue) may accept or return an explicit currency code supplied by the client and are not limited to the organisation default alone.
The fee after any modifiers have been applied.
Charge modifiers (for example fuel levy). Usually omitted when setting charges manually.
File
contentTypeMIME type of the attachment. Must match the Content-Type header used when uploading to uploadUrl.
nameAttachment file name.
idFile UUID used to identify the attachment and construct the storage path.
contentMd5Base64-encoded MD5 checksum of the file content. Must match the Content-MD5 header used when uploading to uploadUrl.
uploadUrlPresigned URL for uploading the file bytes. Present in create/update responses.
downloadUrlPresigned URL for downloading the file bytes. Present in responses.
sizeInBytesAttachment size in bytes.
existsWhether the attachment currently exists in file storage.
DocumentDetails
Each item describes one file and includes presigned uploadUrl and downloadUrl values in responses.
AuditInfo
createdBycreatedTimelastModifiedBylastModifiedTimeDocumentBase
idstatusnamedescriptionAttachment list for this document, or null when none is present.
ConsignmentDocument
typeidstatusnamedescriptionAttachment list for this document, or null when none is present.
FileRequest
contentTypeMIME type of the attachment. Must match the Content-Type header used when uploading to uploadUrl.
nameAttachment file name.
idFile UUID used to identify the attachment and construct the storage path.
contentMd5Base64-encoded MD5 checksum of the file content. Must match the Content-MD5 header used when uploading to uploadUrl.
sizeInBytesAttachment size in bytes.
DocumentRequestDetails
Files to attach. Provide id, name, contentType, sizeInBytes, and contentMd5 for each file. PUT the file bytes to the returned uploadUrl with matching Content-Type and Content-MD5 headers.
DocumentRequestBase
namedescriptionSend an object with attachments to request presigned upload URLs, or null if there are no files.
ConsignmentDocumentRequest
namedescriptionSend an object with attachments to request presigned upload URLs, or null if there are no files.
typeAuditEvent
ideventTimeTime the event occurred.
Identifies a user by id and display name.
actionAction that caused the change.
entityTypeEntity type the event relates to.
entityIdSnapshot of entity data at the time of the event.
Additional context about the change.
AuditEventList
ideventTimeTime the event occurred.
Identifies a user by id and display name.
actionAction that caused the change.
entityTypeEntity type the event relates to.
entityIdSnapshot of entity data at the time of the event.
Additional context about the change.
Condition
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="AndCondition" · requires: conditions | |
| type = object · type="OrCondition" · requires: conditions | |
| type = object · type="AlphanumericComparisonCondition" · requires: method, field, value | |
| type = object · type="BooleanComparisonCondition" · requires: field, value | |
| type = object · type="DateComparisonCondition" · requires: operator, field, value | |
| type = object · type="DateTimeComparisonCondition" · requires: operator, field, value | |
| type = object · type="FieldComparisonCondition" · requires: method, field, value | |
| type = object · type="IsBlankComparisonCondition" · requires: method, field | |
| type = object · type="ListComparisonCondition" · requires: method, field, value | |
| type = object · type="NumericComparisonCondition" · requires: operator, field, value | |
| type = object · type="TextComparisonCondition" · requires: method, field, value |
typeJsonPointerField
typepointerJSON Pointer path of the field to compare
AliasField
typevalueAlias of the field that should match the condition. Can be found in a supplied endpoint documentation
ValueField
typevalueAlphanumericComparisonCondition
typemethodObject providing information about a value that the searching field should be compared with
BooleanValueField
typevalueBooleanComparisonCondition
typeObject providing information about a value that the searching field should be compared with
DateComparisonCondition
typeoperatorObject providing information about a value that the searching field should be compared with
DateTimeComparisonCondition
typeoperatorObject providing information about a value that the searching field should be compared with
FieldComparisonCondition
typemethodObject providing information about a value that the searching field should be compared with
IsBlankComparisonCondition
typemethodListComparisonCondition
typemethodArray of values to match
NumericValueField
typevalueNumericComparisonCondition
typeoperatorObject providing information about a value that the searching field should be compared with
TextComparisonCondition
typemethodComparison method
Object providing information about a value that the searching field should be compared with
WrapperCondition
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="AndCondition" · requires: conditions | |
| type = object · type="OrCondition" · requires: conditions |
typeItemConfirmation
idtenantIdtaskIdThe consignment ID
methodConfirmation method
valueConfirmation value
schemaVersionconfirmedAtTimestamp when the confirmation was made
TransportItemList
idCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
typeBulkUpdateItemListRequest
confirmSaveWhen true, saves even when lastModified does not match the consignment.
lastModified^\d{4}-\d{2}-\d{2} \…Consignment last-modified timestamp (YYYY-MM-DD HH:MM:SS) used to detect conflicting edits.
DownloadLabels
labelCountMap of consignment uuid to label count
returnTypeReturn type. url returns a URL to the generated labels; download returns raw PDF content.
PrintConsignmentItemLabelsItem
itemIdItem identifier
numberOfCopiesNumber of label copies to print for this item
PrintConsignmentItemLabelsConsignment
consignmentIdArray of items with their label copy counts
DownloadConsignmentItemLabels
Array of consignments with their items to download labels for
returnTypeReturn type. url returns a URL to the generated labels; download returns raw PDF content.
PrintConsignmentItemLabels
Array of consignments with their items to print labels for
PrintLabels
labelCountMap of consignment uuid to label count
ConsignmentQuoteNamedReference
nameNamedReference
idnameOptional display name.
ConsignmentQuoteResponse
Rate card used for the quote.
Rate matched for the quote.
List of produced charges.
Zone used for the collect address when quoting.
Zone used for the deliver address when quoting.
Service type used when matching the rate.
SearchRequest
And and Or conditions must be accompanied with internal conditions property that provides all the fields level conditions that the wrapper must be applied to. Note: The FreeTextSearch condition cannot be combined with other fields level conditions.
CustomerWarehouseReference
idnameCustomer
nameCompany name for the customer.
emailEmail address for the customer.
enabledidscopetelephonePhone number for the customer.
Warehouses for which the customer is used. If not provided, assigned to the default warehouse.
CustomerCreate
nameCompany name for the customer.
emailEmail address for the customer.
enabledscopeCUSTOMER for customer entities.
telephonePhone number for the customer.
Warehouses for which the customer is used. If not provided, assigned to the default warehouse.
EntityClass
Lowercase path segment for a tenant entity definition.
BaseDefinition
titleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
BooleanDefinition
typedefaulttitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
IntegerDefinition
typedefaultmultipleOfminimummaximumtitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
NumberDefinition
typedefaultmultipleOfminimummaximumtitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
StringDefinition
typedefaultminLengthmaxLengthpatternformattitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
EntityDefinition
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · type="boolean" | |
| type = object · type="integer" | |
| type = object · type="number" | |
| type = object · type="string" | |
| type = object · type="array" | |
| type = object · type="object" |
typedefaulttitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
ArrayDefinition
typeminItemsmaxItemstitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
ObjectDefinition
typetitleLabel for the field.
descriptionDescription of field. Could be used for a tooltip or field information.
deprecatedIndicates that the value the keyword applies to should not be used and may be removed in the future. Currently set to true for disabled custom fields.
readOnlyField generated / calculated by the system and cannot be set, only read. Defaults to false.
TenantDocumentRequest
typeDocument type code. OUTBOUND_ORDER_INVOICE applies to owner type OUTBOUND.
TenantDocument
typeidInboundOrderReferences
numericIdcustomerOrder reference specified by Customer
InboundOrderStatus
Status of the inbound order
InboundDetails
hasChildrenisAdjustmentIs this order a stock adjustment instead of a standard order
urgencyUrgency status for this order
arrivalDateExpected arrival date of the order
instructionsSpecial instructions for receiving the order
parentIdurgentWhether the inbound order is urgent
InboundOrder_CoreRequest
Fields uniquely identifying Inbound order
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
measuresstatusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Details specific for the Inbound Order object
InboundItemReferences
numericIdcustomerCustomer- or supplier-supplied item reference (e.g. line item code)
POPStatus
Status of an inbound item
Product
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id | |
| type = object · requires: name | |
| type = object · requires: references | |
| type = object · requires: references |
idnameName of the product
InboundItemRequest
Physical measurements of the item
Additional details about the inbound item
Fields uniquely identifying Inbound item
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
typeType of the inbound item. Defaults to ITEM if not provided.
statusStatus of the inbound item. Defaults to OK if not provided.
InboundOrderRequest
Fields uniquely identifying Inbound order
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
measuresstatusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Details specific for the Inbound Order object
List of Inbound Item objects
InboundOrder_Core
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Inbound order
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Only returned when the Include request header contains measures.
statusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Map of timestamp entries for various lifecycle events
versionExternal Metadata by a specific External meta key
Details specific for the Inbound Order object
InboundItem
idFields uniquely identifying Inbound item
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Physical measurements of the item
typeType of the inbound item. Defaults to ITEM if not provided.
statusStatus of the inbound item. Defaults to OK if not provided.
Additional details about the inbound item
InboundOrder_Default
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Inbound order
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Only returned when the Include request header contains measures.
statusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Map of timestamp entries for various lifecycle events
versionExternal Metadata by a specific External meta key
Details specific for the Inbound Order object
List of Inbound Item objects
BulkDeleteEntityRequest
Search filter selecting entities to delete. condition is required.
TaskMinimal
idtypeOptional entity-specific reference values for display (for example customer reference or numeric ID).
BulkDeleteEntityReference
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id, type |
idtypeOptional entity-specific reference values for display (for example customer reference or numeric ID).
BulkDeleteFailure
All reasons the entity could not be deleted.
BulkDeleteSuccess
BulkDeleteResponse
InboundOrder_NoItems
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Inbound order
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Only returned when the Include request header contains measures.
statusStatus of the inbound order
Identifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
Map of timestamp entries for various lifecycle events
versionExternal Metadata by a specific External meta key
Details specific for the Inbound Order object
InboundOrderDocument
typeidstatusnamedescriptionAttachment list for this document, or null when none is present.
InboundOrderDocumentRequest
namedescriptionSend an object with attachments to request presigned upload URLs, or null if there are no files.
typePrintLabelItem
countidOutboundOrder_CoreRequest
Fields uniquely identifying Outbound order
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
measuresstatusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
External Metadata by a specific External meta key
sourceSource information for the entity
OutboundError
messageError details
isResolvedWhether the error has been resolved
errorTypeNOT FULLY DOCUMENTED Error code:
10448- Not enough stock for the Product10449- Product not found11000- Customer not found
OutboundDetails_Default
allowSplittingIf set to true, the order can be split into multiple orders. This is useful when the order contains multiple items and some of them are not available for shipping Backordering project
Delivery Address and details
Delivery Address and details
Total expense charge for the order. Only present when the user can view charging information. Currency is the effective default for the order's warehouse.
Total income charge for the order. Only present when the user can view charging information. Currency is the effective default for the order's warehouse.
instructionsPacking instruction for the order
The total invoice value for the order. Clients may supply any valid ISO 4217 currency code.
When currency is omitted on create or update, the effective currency for the order's warehouse
is used (warehouse override when configured, otherwise the organisation default).
isAdjustmentWhether the order is an adjustment order.
urgentOutboundItemReferences
numericIdOutboundOrderItemRequest
Fields uniquely identifying Outbound item
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
typeOutboundOrderRequest
Fields uniquely identifying Outbound order
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
typeCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
measuresstatusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
External Metadata by a specific External meta key
sourceSource information for the entity
Reference to the Parent Order that this Outbound Order belongs to. Parent Orders are not yet implemented and are only stored as UUIDs.
Details specific for the Outbound Task object
Stock
idtypeThe inbound order item that this stock was sourced from
groupWhere the stock has been allocated to
locationWhere the stock is physically located. Returns null if the related inbound order item has not been received yet, or has left the warehouse without being placed in a consignment item.
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
OutboundOrderItem
idFields uniquely identifying Outbound item
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
typeExternal Metadata by a specific External meta key
List of Stock items allocated to this item. May be undefined or empty if no stock has been allocated yet.
OutboundOrder_Default
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Outbound order
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Contains information about size of the order.
statusIdentifies a warehouse. When both id and name are supplied, id is used first.
name must match the warehouse name in CartonCloud exactly.
versionExternal Metadata by a specific External meta key
sourceSource information for the entity
Map of timestamp entries for various lifecycle events
Reference to the Parent Order that this Outbound Order belongs to. Parent Orders are not yet implemented and are only stored as UUIDs.
Details specific for the Outbound Task object
OutboundOrder_SearchResult
idThe customer that this entity is associated with. null for tenant data not associated with a specific customer. A user's access maybe restricted to specific customers. Also null for multi-customer groups. Pick To Tote as example (although each individual group member has its own customer reference).
Billing invoice this entity is assigned to. Only present when the entity has an assigned invoice and the user has VIEW_CHARGES permission.
typeFields uniquely identifying Outbound order
versionstatusContains information about size of the order and adhoc charges information
If Outbound is part of Pick To Tote task, it's reference will be provided here
OutboundOrder_Reference
idPackingSlipTemplate
Packing slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
OutboundOrderPackingSlipPrintRequest
templatePacking slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
consignmentItemIdOptional consignment item UUID. Narrows the PDF to one page for that item. Omit it for the whole order. An empty string is treated as omitted.
Supply exactly one UUID. Line-number placeholders use that item's position in the full order. Items without packed products still receive a page. When the order has no consignment items, sale order and consignment headers still render when consignments exist on the order.
Applies to AGGREGATED and PER_ITEM. Returns 400 when the UUID is invalid or does not belong to this outbound order.
PackingSlipPrintSuccess
printJobIdRemote print job identifier returned by the printing provider (for example PrintNode). May be null when the provider does not return an identifier.
OutboundOrderPackingSlipSnapshotRequest
templatePacking slip layout.
AGGREGATED, no consignment item: one PDF for the whole order.AGGREGATED, with a consignment item: one PDF, one page for that item.PER_ITEM, no consignment item: one merged PDF, one page per consignment item, in pack-list order. Pages are built in chunks of up to 20 and then merged.PER_ITEM, with a consignment item: one PDF, one page for that item.
Packed quantities per consignment item. packedProducts[].id is the sale order product UUID (same as OutboundOrderItem.id on GET …/items).
May be [] (empty product context for all items on the order; no error). Consignment items not listed in snapshot use empty product context, not persisted SOP quantities.
Whole order, no consignmentItemId: AGGREGATED → one PDF; PER_ITEM → one merged PDF (one page per item; chunked internally). With consignmentItemId: one page for that item; missing snapshot row → empty product context.
consignmentItemIdOptional consignment item UUID. Narrows the PDF to one page for that item. Omit it for the whole order. An empty string is treated as omitted.
Supply exactly one UUID. Line-number placeholders use that item's position in the full order. Items without packed products still receive a page. When the order has no consignment items, sale order and consignment headers still render when consignments exist on the order.
Applies to AGGREGATED and PER_ITEM. Returns 400 when the UUID is invalid or does not belong to this outbound order.
TransportProduct
idtypenameIdentifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
measuresCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
enabledTransportProductRequest
typenameIdentifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
measuresCustom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
enabledProductSearchConstraint
ProductBulkUpdateRequest
enabledValue written to each matching product.
ProductMutateRequest
nameBulkChargesReportParameters
chargeClassesFilter by charge class: CONSIGNMENT, MANIFEST, PURCHASE_ORDER, RUN_SHEET, SALE_ORDER, or STORAGE_PERIOD.
Filter by customers the charges belong to.
dateFilterDate field used to filter charges. date_added is charge created date.
date_invoice uses invoice start/end dates. date_activity uses the
activity date for the charge class: consignment delivered, manifest added,
purchase order allocated, run sheet delivery date, sale order packed, or
storage period start/end (end after fromDate if set; start before toDate
if set).
fromDateStart of the date range (YYYY-MM-DD).
pageSizeItems per page. Omitted uses the default. Values above 100 are capped at 100.
toDateEnd of the date range (YYYY-MM-DD).
StockOnHandReportParameters
Customer whose stock is included.
aggregateByExtra aggregation criteria. productStatus and unitOfMeasure are always
applied. location is only for API clients with unlimited customer access.
Customer product custom fields and purchase-order product custom fields
(for example expiryDate, batch, barcode) are also allowed.
pageSizeItems per page. Omitted uses the default. Values above 100 are capped at 100.
Warehouse reference. Defaults to the default warehouse when omitted.
IdentifiableEntity
idApiReportRun
typestatusreportTimeTime the report was generated.
idStockOnHandReportItem
Values for each aggregateBy criterion (and always-applied criteria). Custom
product or purchase-order product fields may also appear here.
typeRow type.
StockOnHandReportRunView
typeStock rows. Present when status is SUCCESS.
statusreportTimeTime the report was generated.
idBulkChargesReportItem
accountAccount.
activityDateCharge activity date. Present when dateFilter is date_activity.
automaticWhether the charge was created automatically (for example Yes).
chargeCharge amount.
createdDateCharge created date.
customerCustomer name.
descriptionCharge description.
feeCategoryFee category.
idNumeric charge id. Distinct from uuid.
invoiceEndDateInvoice end date.
invoiceIdId of the invoice the charge is attached to.
invoiceStartDateInvoice start date.
parentEntityCharge class (parent entity type).
parentIdNumeric parent entity id. Distinct from parentUuid.
parentReferenceParent entity reference.
parentUuidUUID of the parent entity. Distinct from parentId.
qtyCharge quantity.
typeIncome or Expense.
uuidCharge UUID. Distinct from id.
warehouseNameWarehouse name.
BulkChargesReportRunView
typeCharge rows. Present when status is SUCCESS.
statusreportTimeTime the report was generated.
idFailedReportRunView
typeErrors when status is FAILED.
statusreportTimeTime the report was generated.
idWarehouseList
References
customerCustomer-supplied reference
trackingExternal tracking number used on consignments
Other custom reference types defined for the tenant
details
variableWeightWhether the product has variable weight.
storageStorage configuration for warehouse product
inboundInbound configuration for warehouse product
stockSelectionStock selection configuration for product. If not provided, the default value will be applied.
activeWhether the product is active
Country of origin. Requires Accept-Version 7 or higher on warehouse-product write operations.
harmonizedSystemCodeHarmonized System (HS) Code for product classification used in international trade.
Requires Accept-Version 7 or higher on warehouse-product write operations.
See Harmonized System (HS) Codes Documentation for more information.
Validation Rules:
-
Only accepts numeric characters (0-9) and period (.) characters
-
Period characters are automatically removed prior to saving
-
Must contain at least 6 numeric characters after periods are removed
UnitOfMeasureConversionRequest
baseQtyBase quantity for conversion
isDirectlyShippableWhether the product can be shipped directly when in this unit of measure.
weightGross weight value with up to 3 decimal places.
lengthLength value with up to 3 decimal places.
widthWidth value with up to 3 decimal places.
heightHeight value with up to 3 decimal places.
barcodeBarcode for the product's unit of measure. If the base unit of measure barcode is not provided, the product code will automatically be applied as the barcode for the base unit of measure.
descriptionProduct-specific label for this unit of measure conversion. When omitted on create, defaults to the product name.
WarehouseProductRequest
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
descriptionProduct description
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
WarehouseProduct
nameProduct name
typeProduct type name. See Product Types documentation for more information.
Identifies a customer. When more than one identifying property is supplied, they are
checked in this order: id, references.code, then name.
scopeExternal or alternate identifiers for a resource, in addition to id (always a UUID).
Values may or may not be unique, depending on tenant and customer configuration. Tenants can define additional reference types beyond the common keys below.
defaultUnitOfMeasureCode of the default unit of measure
iddescriptionProduct description
Custom and other property values keyed by name.
Custom fields may exist or may be requested by the tenant.
- For Address, Shipment, Container, Consignment Data, Consignment Item, Vehicle, Customer, Driver, Sale Order, Purchase Order, or Transport Product, use the name in Mapped Field from the tenant.
- For Sale Order Product (SOP) custom fields, use
sop_custom_field_1,sop_custom_field_2, and so on. - For other entities such as Purchase Order Product and Product, use
custom_field_1,custom_field_2, and so on.
Property (Custom Field) requirements for warehouse product. If a custom field is omitted from this object, the behavior will replicate customer-level settings.
All unit of measures defined for warehouse product
Array of warehouse product notifications
timestampsMap of timestamp entries for the Warehouse Product lifecycle events
UnitOfMeasureConversion
baseQtyBase quantity for conversion
isDirectlyShippableWhether the product can be shipped directly when in this unit of measure.
idnameName of the tenant unit of measure referenced by this conversion key
weightGross weight value with up to 3 decimal places.
lengthLength value with up to 3 decimal places.
widthWidth value with up to 3 decimal places.
heightHeight value with up to 3 decimal places.
barcodeBarcode for the product's unit of measure. If the base unit of measure barcode is not provided, the product code will automatically be applied as the barcode for the base unit of measure.
descriptionProduct-specific label for this unit of measure conversion. When omitted on create, defaults to the product name.
isDecimalWhether the unit supports decimal values
transportProductMappingThe transport product this warehouse product maps to