Create an Order

Creates an order.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

order

object

required

Details about the order

entry_date

string <date>

required

Order Date

extref

string

optional

Order Number

input_output

enum<string>

required

Indicates if the order is an input or output

Allowed values:

inputoutput

file_no

string

optional

Delivery Number

order_no

string

optional

Order number

sender_code

string

optional

Code of the sender

sender_name

string

optional

Name of the sender

consignee_code

string

optional

Code of the consignee

consignee_name

string

optional

Name of the consignee

order_address

string

optional

Address where the order is to be delivered

city

string

optional

City of the delivery address

district

string

optional

District of the delivery address

warehouse_code

string

required

Code of the warehouse

notes

string

optional

Additional notes about order

interface_code

string

optional

Interface code associated with the order

from_location_code

string

optional

Output location code

to_location_code

string

optional

Input location code

status

string

optional

Status of the order

arrival_date

string <date>

optional

Expected date of arrival

process_type

string

optional

Process type of the order

orderlines_attributes

array [object {15}]

required

Lines of products included in the order

Example

{
  "order": {
    "input_output": "input",
    "warehouse_code": "TEST1212",
    "notes": "ApiTest",
    "extref": "AT121314",
    "entry_date": "2024-08-22",
    "sender_name": "Demo Uk",
    "consignee_name": "YUMCO COMMERCE DOO",
    "order_address": "123 Baker Street, Suite 456, London, Greater London, NW1 6XE, United Kingdom",
    "district": "Greater London",
    "city": "London",
    "orderlines_attributes": [
      {
        "line_no": "1",
        "serial_no": "TA121314",
        "weight": "200.0",
        "volume": "100.0",
        "productName": "TestApi",
        "barCode": "TestApi",
        "packCount": "10",
        "packType": "Box"
      }
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

order_id

string

required

ID of the Declaration Order

reference

string

required

Reference number of Declaration order

assignee_email

string

required

Email of the assignee

operator_email

string

required

Email of the operator

position_id

integer

required

Position No

notes

string

required

Additional notes

ncts_declarations

array [object {14}]

required

transaction_id

integer

optional

Transaction ID of the NCTS Declaration

reference

string

optional

Reference number of the NCTS Declaration

trailer_code

string

optional

Code/Plate Number of the trailer

vehicle_code

string

optional

Code/Plate Number of the vehicle

container

string

optional

Container

lrn

string

optional

LRN Number

mrn

string

optional

MRN number

status

string

optional

Status of the NCTS Declaration

carrier_name

string

optional

Name of the carrier

guarantee_price

number

optional

NCTS declaration's guarantee amount

guarantee_curr

string

optional

NCTS declaration's guarantee currency

manifesto_price

number

optional

NCTS declaration's price

currency

string

optional

Currency of NCTS declaration

holder_name

string

optional

Name of the holder

Example

{
    "order_id": "string",
    "reference": "string",
    "assignee_email": "string",
    "operator_email": "string",
    "position_id": 0,
    "notes": "string",
    "ncts_declarations": [
        {
            "transaction_id": 0,
            "reference": "string",
            "trailer_code": "string",
            "vehicle_code": "string",
            "container": "string",
            "lrn": "string",
            "mrn": "string",
            "status": "string",
            "carrier_name": "string",
            "guarantee_price": 0,
            "guarantee_curr": "string",
            "manifesto_price": 0,
            "currency": "string",
            "holder_name": "string"
        }
    ]
}

🟠403Forbidden

🟠404Record Not Found

🟠400Bad Request

🟠422Unprocessable Entity