📦Order items

This API is available for versions v.2.62.11 and later after 2024-10-04.

Best practices

During integration, an order item (contact-order-item) must specify the product (Product) and the order it belongs to (order). The integration steps are as follows:

1. Find the corresponding order ID (contact_order_id) based on the order number (order_number).

2. Obtain the product ID (product_id) based on the product SKU (sku) or other information.

3. Use the order number (order_number) and product ID (product_id) to create or update the order item.

These steps ensure each order item is correctly associated with the corresponding product and order, improving the accuracy and efficiency of data integration.

Search

GET https://{API_DOMAIN}/api/v1/contact-order/{contact_order}/contact-order-item

curl -X GET
    -H "Content-Type: application/json"
    '{"name": "vip"}'
    https://{API_HOST}/api/v1/{contact_order}/contact-order-item

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Array of sales order item data
meta	Object	Pagination data

{
    "data": [
        {
            "id": 2,
            "quantity": 1,
            "total_price_before_discounts": "3100.00",
            "total_discount": "0.00",
            "total_price_after_discounts": "3100.00",
            "product_id": 3,
            "contact_order_id": 1,
            "product":
            {
                "id": 3,
                "name": "Women's Dunk Low Medium Olive",
                "sku": "DD1503-120",
                "price": 3100,
            },
            "created_at": "2024-09-27 15:44:03",
            "updated_at": "2024-09-27 15:44:03"
        }
    ],
    "links": { ... },
    "meta": { ... }
}

Get single record

GET https://{API_DOMAIN}/api/v1/contact-order/{contact_order}/contact-order-item/{contact_order_item}

curl -X GET
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/contact-order/1/contact-order-item/36

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
id	true	NULL	Number	Contact tag system ID

Response

PROPERTY	TYPE	DESCRIPTION
data	Object	Sales order item data

{
    "data": {
        "id": 2,
        "quantity": 1,
        "total_price_before_discounts": "3100.00",
        "total_discount": "0.00",
        "total_price_after_discounts": "3100.00",
        "product_id": 3,
        "contact_order_id": 1,
        "product":
        {
            "id": 3,
            "name": "Women's Dunk Low Medium Olive",
            "sku": "DD1503-120",
            "price": 3100,
        },
        "created_at": "2024-09-27 15:44:03",
        "updated_at": "2024-09-27 15:44:03"
    }
}

Create

POST https://{API_DOMAIN}/api/v1/contact-order/{contact_order}/contact-order-item

curl -X POST
    -H "Content-Type: application/json"
    '{"product_id": 3, "quantity": 2 }'
    https://{API_HOST}/api/v1/contact-order/1/contact-order-item

Form Data

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
product_id	true	NULL	Integer	Unique identifier of the associated product
quantity	true	NULL	Integer	Quantity of the purchased product
total_price_before_discounts	false	NULL	Decimal(10,2)	Total item price before discounts are applied
total_discount	false	NULL	Decimal(10,2)	Total discount amount applied to the item
total_price_after_discounts	false	NULL	Decimal(10,2)	Final item price after discounts are applied

Response

{
    "data": {
        "id": 2,
        "quantity": 1,
        "total_price_before_discounts": "3100.00",
        "total_discount": "0.00",
        "total_price_after_discounts": "3100.00",
        "product_id": 3,
        "contact_order_id": 1,
        "product":
        {
            "id": 3,
            "name": "Women's Dunk Low Medium Olive",
            "sku": "DD1503-120",
            "price": 3100,
        },
        "created_at": "2024-09-27 15:44:03",
        "updated_at": "2024-09-27 15:44:03"
    }
}

Update

PUT https://{API_DOMAIN}/api/v1/contact-order/{contact_order}/contact-order-item/{contact_order_item}

curl -X PUT
    -H "Content-Type: application/json"
    '{"product_id": 3, "quantity": 2 }'
    https://{API_HOST}/api/v1/contact-order/1/contact-order-item/36