Create Order

This API allows a marketplace application to create an order in the system by providing customer, product, and payment details.

Endpoint

URL: /api/orders/create

Method: POST

Content-Type: application/json

Request Body

Root Object:

Parameter	Type	Required	Description
branch	string	Yes	The unique identifier of the branch.
customer	Customer[]	Yes	An object containing the customer's details.
discount	Discount[]	No	Optional discount details for the order.
note	string	No	Additional notes for the order.
ordertype	string	No	The order type ID obtained from the order type API.
partner_reference	string	No	Reference ID for the order in the partner system.
payments	Payments[]	No	Payment details for the order.
products	Product[]	Yes	A list of products included in the order.
subtotal	number	No	The subtotal amount before tax and discounts.
tax	number	No	The total tax amount for the order.
taxes	Taxes[]	No	A list of taxes applied to the order.
total	number	No	The total amount after tax and discounts.

Customer Object:

Parameter	Type	Required	Description
address	Address	No	Customer's address details.
name	CustomerName	No	Customer's name in multiple languages.
phone	string	Yes	Customer's phone number.

Address Object:

Parameter	Type	Required	Description
address	string	Yes	The detailed address.
id	string	Yes	Unique identifier for the address.
latitude	string	Yes	Latitude coordinate.
longitude	string	Yes	Longitude coordinate.
name	AddressName	Yes	Name for the address in multiple languages.
note	string	No	Additional notes about the address.

Product Object:

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the product.
quantity	number	Yes	Quantity of the product ordered.
total	number	Yes	Total amount after tax and discounts.
discount	number	No	Discount applied to the product.
modifiers	Modifier[]	No	List of modifiers applied to the product.
note	string	No	Additional notes for the product.
subtotal	number	No	Subtotal amount before tax and discounts.
tax	number	No	Tax amount for the product.
taxes	Tax[]	No	List of taxes applied to the product.
variant	string	No	Specific variant of the product.

Modifier Object:

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the modifier.
amount	number	Yes	Price or amount associated with the modifier.
quantity	number	Yes	Quantity of the modifier applied.

TAX Object:

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the tax.
value	number	Yes	Value of the tax applied.

Payments Object:

Parameter	Type	Required	Description
id	string	Yes	Unique identifier for the payment method or transaction.
amount	number	Yes	Total amount paid for the order.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

branch

string

required

partner_reference

string

optional

Refrence for this order in your system

customer

object

required

phone

string

required

name

object

optional

address

object

optional

products

array [object {10}]

required

string

required

quantity

number

required

total

number

required

variant

string

optional

subtotal

number

optional

tax

number

optional

discount

number

optional

note

string

optional

modifiers

array [object {3}]

optional

taxes

array [object {2}]

optional

ordertype

string

optional

note

string

optional

total

number

optional

subtotal

number

optional

tax

number

optional

discount

object

optional

code

string

optional

amount

number

optional

taxes

object

optional

string

required

value

number

required

payments

object

optional

string

required

amount

number

required

charges

object

optional

string

optional

amount

number

optional

auto_accept

boolean

optional

Example

{
    "branch": "01hvxcfmtfbr3x3ph8r81kdtqj",
    "customer": {
        "phone": "055123456"
    },
    "charges":{
        "id":"string",
        "value":"decimal"
    },
    "partner_reference": "Jahez: 12327",
    "auto_accept":true,
    "note": "cut in half please",
    "total": 11.5,
    "subtotal":10,
    "tax": 1.15,
    "ordertype": "01hw7tf60necbpr8rps6xg78cq",
    "products": [
        {
            "id": "01GZK6C7J03PQP7KGRAQ3F197Y",
            "variant": "01j82mx3m4376mp9rw5a9rxkbx",
            "quantity": 2,
            "total": 11.5,
            "subtotal": 10,
            "tax": 1.15,
            "discount": 0,
            "note": null,
            "modifiers": [
                {
                    "id": "01hpkd1wj0k9bfermyc8cy0agk",
                    "quantity": 2,
                    "amount":0
                }
            ],
            "taxes": [
                {
                    "id": "01j9t4g36v6vgz798bd3nj3ezh",
                    "value": 1.15
                }
            ]
        }
    ],
    "payments": [{
        "id": "01GZERV8JPY7PNWM2HJ5RXYG2K",
        "amount": 10
    }],
    "taxes": [
        {
            "id": "01j9t4g36v6vgz798bd3nj3ezh",
            "value": 1.15
        }
    ]
}

Responses

🟢200Success

application/json

Body

message

string

required

order

object

required

string

required

order_reference

string

required

partner_reference

string

optional

Your unique value

Example

{
    "message": "Order Created Successfully",
    "order": {
        "id": "01jh0tfx4khneamer3ks2s5sa4",
        "order_reference": 290,
        "partner_reference": "Jahez: 12327"
    }
}

Create Order

Create Order#

Endpoint#

Request Body#

Request

Responses

Create Order

Endpoint

Request Body