Validation
Validate single or multiple shipping orders
Validate shipping order(s)
The request should be used for shipping order validation. This request is useful if you want to show user validation errors before the expedition process.
- For single shipping order validation, use Content-Type: application/cham.shipping-order+json
- For multiple shipping orders validation, use Content-Type: application/cham.shipping-orders+json
In case of a successful or failed validation, it will return the status code 200 OK. A response body contains the property status which determines validation status. It is one of OK, WARNING, and ERROR. An attribute messages contains validation messages.
path Parameters
courier_idID of courier
query Parameters
profileID of configuration
Validate shipping order(s) › Request Body
ReferenceNumberUnique value that identify entity in the application Chameleoon
ExternalReferenceReference that identify entity in your system
ReferenceSourceOptional. System the shipment is attributed to. Defaults to api when omitted, empty or blank, so existing integrations that never send this field are unaffected. Notification triggers, statistics attribution and order-state synchronization back to your e-shop or ERP are keyed on the ReferenceSource + SourceIdentifier pair, so set it when you want a shipment routed as if it originated in one of your connected systems. Use the identifier of a source connected to your account (see GET /configurations/sources).
The pair is validated against the sources activated on your account (see GET /configurations/sources); a pair that matches none of them is rejected with 422. The values must match the configured source and profile ids exactly, casing included. The pair api / default is always accepted.
ReferenceSource and SourceIdentifier must be supplied together — send both or neither.
SourceIdentifierOptional. Identifier of the concrete instance of ReferenceSource, used to distinguish several instances of the same source (for example two e-shops on the same platform). Defaults to default when omitted, empty or blank.
ReferenceSource and SourceIdentifier must be supplied together — send both or neither.
Validate shipping order(s) › Responses
Validation completed (can be OK, WARNING, or ERROR status)
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
statusStatus of validation result, one of OK, WARNING, ERROR
referenceNumberReference number of sent shipping order