Create Order History - Salla Public APIs Docs

This endpoint allows you to append a note to the Order History, by passing the order_id as a path parameter.

Scopes

orders.read_write - Orders Read & Write

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Path Params

order_id

integer

required

The Order ID. List of Order ID can be found here

Body Params application/json

note

string

required

Note value

Example

{
    "note": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

number

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

object (POSTOrderHistory)

optional

number

required

A unique identifier associated with a specific entry or record in a database containing information about a customer's past order or transaction history.

status

string

required

The current state or condition of an order.

customized

object

required

note

string

required

A record or comment associated with a specific order.

created_at

object (Date)

required

POST order history date an time of creation.

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 1333127585,
        "status": "مسترجع",
        "customized": {
            "id": 2062355698,
            "name": "مسترجع",
            "type": "custom",
            "slug": "restored",
            "original": {
                "id": 989286562,
                "name": "مسترجع"
            },
            "parent": null
        },
        "note": "ملاحظة",
        "created_at": {
            "date": "2023-02-21 11:09:57.000000",
            "timezone_type": 3,
            "timezone": "Asia/Riyadh"
        }
    }
}

🟠422Error Validation

🟠401Unauthorized