POST Checkout

Developing

POST

{{url}}api/v1/ecommerce/checkout

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ecompulse.test/api/v1/ecommerce/checkout' \
--header 'Accept: application/json' \
--header 'X-API-Key: exzbLclGAzBCyL0k1Yv29Evu6mwoYOATBF0lWPyT' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference_no": "ECOM1105262",
    "warehouse_id": 1,
    "customer_id": 5,
    "date": "2024-05-19 13:10:33",
    "note": "ecommerce sale",
    "order_tax": 0.00,
    "order_shipping": 250.00,
    "order_discount": 702.00,
    "grand_total": 6568.00,
    "payment": {
        "amount": 6568.00,
        "paying_by": 1
    },
    "products": [
        {
            "id": 10,
            "price": 119.00,
            "product_net_price": 119.00,
            "qty": 1,
            "discount": 0.00,
            "weight_based_price": 0.00,
            "product_price_tax": 0.00,
            "subtotal": 119.00
        },
        {
            "id": 15,
            "price": 235.00,
            "product_net_price": 215.00,
            "qty": 1,
            "discount": 20.00,
            "weight_based_price": 0.00,
            "product_price_tax": 12.90,
            "subtotal": 227.90,
            "option_id": 2,
            "option_values": [
                {
                    "label": "White",
                    "qty": 1
                }
            ]
        }
    ]
}'

Response Example

{
    "status": "success",
    "message": "Ecommerce Sale created successfully",
    "data": {
        "id": 9,
        "reference_no": "ECOM1105262",
        "date": "2024-05-19 13:10:33",
        "note": "Ecommerce sale",
        "order_tax": "0.00",
        "order_shipping": "250.00",
        "order_discount": "702.00",
        "grand_total": "6,568.00",
        "paid": "6,568.00",
        "balance": "0.00",
        "customer_payment": {
            "paid": "6,568.00",
            "change": "0.00",
            "paying_by": "Card"
        },
        "paid_status": {
            "value": 1,
            "text": "Paid"
        },
        "warehouse": {
            "id": 1,
            "name": "Warehouse 1"
        },
        "customer": {
            "id": 5,
            "name": "Gore"
        },
        "biller": {
            "id": 2,
            "name": "William"
        },
        "sale_by": "Ecommerce",
        "status": {
            "value": 1,
            "text": "Completed"
        },
        "products": [
            {
                "id": 10,
                "sku": "P10",
                "name": "Girl Summer bracelets",
                "total_qty": 30,
                "qty": 1,
                "price": "119.00",
                "product_net_price": "119.00",
                "discount": "0.00",
                "weight_based_price": "0.00",
                "product_price_tax": "0.00",
                "subtotal": "119.00",
                "tax_method_id": null,
                "tax_id": null,
                "option_id": null,
                "option_values": null
            },
            ...
            ...
            ...
        ],
        "payments": [
            {
                "id": 14,
                "paid_date": "2024-05-19 13:10:33",
                "amount": "6,568.00",
                "note": "customer ecommerce payment",
                "paying_by": {
                    "value": 1,
                    "text": "Card"
                }
            }
        ]
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

string

required

Example:

application/json

X-API-Key

string

required

Example:

Body Params application/json

object {0}

Examples

Responses

🟢201Created

application/json

Body

object {0}

POST Cart Discount

DELETE Cart