Salla Docs

Create Order Item

Production

https://api.salla.dev/admin/v2

POST

/orders/items

Order Items

Last modified:2024-12-29 06:40:32

This endpoint allows you to create an order item for a specific order by passing its ID in the body request.

Scopes

orders.read_write - Orders Read & Write

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.salla.dev/admin/v2/orders/items' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_id": 837293123,
    "identifier_type": "id",
    "identifier": 123456,
    "quantity": 1,
    "branch_id": 12342,
    "options": [
        {
            "id": 789012,
            "value": [
                "value1",
                "value2"
            ]
        }
    ],
    "name": "Custom Product Name",
    "price": 100.00,
    "cost_price": 80.00,
    "weight": 150,
    "weight_type": "g"
}'

Response Example

200 - Success

{
    "status": 200,
    "success": true,
    "data": [
        {
            "id": 365435777,
            "name": "SSD",
            "sku": "sam-ssd-256g",
            "quantity": 1,
            "currency": "SAR",
            "weight": 0.51,
            "weight_label": "٥١٠ جم",
            "amounts": {
                "price_without_tax": {
                    "amount": 150,
                    "currency": "SAR"
                },
                "total_discount": {
                    "amount": 0,
                    "currency": "SAR"
                },
                "tax": {
                    "percent": "15.00",
                    "amount": {
                        "amount": 22.5,
                        "currency": "SAR"
                    }
                },
                "total": {
                    "amount": 150,
                    "currency": "SAR"
                }
            },
            "notes": "",
            "options": [
                {
                    "id": 675638105,
                    "product_option_id": 1902643925,
                    "name": "size",
                    "type": "radio",
                    "value": {
                        "id": 1090448197,
                        "name": "256G",
                        "price": {
                            "amount": 0,
                            "currency": "SAR"
                        }
                    }
                }
            ],
            "images": [],
            "codes": [],
            "files": [],
            "reservations": [],
            "branches_quantity": []
        }
    ]
}

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Body Params application/json

order_id

integer

required

Order ID. List of Order ID can be found here

identifier_type

enum<string>

optional

Product item identifier type

Allowed values:

idsku

identifier

integer

optional

Order Item Identifier ID. List of Order Items can be found here

quantity

integer

optional

Order Item Quantity

branch_id

integer

optional

Branch ID. List of Branch ID can be found here.

options

array [object {2}]

optional

integer

optional

Product Option ID

value

array[string]

optional

name

string

optional

Product Name, list of products can be found here.

price

integer

optional

Product Price.

cost_price

integer

optional

Product Cost Price.

weight

integer

optional

Product Weight Value.

weight_type

string

optional

Product Weight Type.

Examples

Responses

🟢200Success

application/json

Body

status

integer

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (OrderItem) {15}]

optional

number

required

A unique identifier, typically numerical or alphanumeric, assigned to an individual item or product within an order.

name

string

required

The name or description of an individual item or product within an order.

sku

string

required

Stock Keeping Unit, and it is a unique code or identifier used to track and manage individual products or items in inventory, facilitating inventory management, sales tracking, and product identification.

quantity

integer

required

The numerical count of a specific item or product included in an order, indicating how many of that particular item have been purchased or are part of the order.

currency

string

required

The specific currency in which the price or value of an individual item within an order is expressed, indicating the monetary unit used for pricing that particular item.

weight

number

required

The numerical measurement representing the weight of an individual item or product within an order.

weight_label

string

required

A textual label or description associated with the weight of an individual item within an order, typically used to indicate the unit of measurement (e.g., kg, lb) and provide clarity regarding how the item's weight is expressed.

amounts

object

required

notes

string

required

Order items notes

options

array [object {5}]

required

images

array [object {3}]

required

codes

array [object {2}]

required

files

array [object {3}]

required

reservations

array [object {4}]

required

branches_quantity

array[integer]

required

🟠404Not Found

🟠401Unauthorized

Modified at 2024-12-29 06:40:32

List Order Items

Update Order Item