Order Actions - Salla Merchants APIs

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

operations

array [object {2}]

required

action_name

enum<string>

required

The actions to be conducted in bulk, which the value can only be from the enum list mentioned.

Allowed values:

create_shipping_policycreate_return_policyprint_shipping_policycancel_policyassign_usersexportassign_tagschange_statusprint_prepare_listprint_invoicesend_invoiceprint_invoice_summarysend_payment_linkextend_payment_dueresend_codessend_ratingmark_as_readrefunddelete

value

array [anyOf]

optional

Value can either be an object, an array of strings or array of integers. This variable is not required for some actions, such as print_prepare_list, but required in some other actions, such as change_status

filters

object

required

order_ids

array[integer]

optional

List of Order IDs. Fetch a list of orders from here

order_status

array[integer]

optional

List of Order Statuses. Fetch a list of orders statuses from here

Example

{
    "operations": [
        {
            "action_name": "print_prepare_list"
        },
        {
            "action_name": "change_status",
            "value": {
                "status": 525144736,
                "send_status_sms": true,
                "return_police": true,
                "restore_items": true,
                "note": "one note",
                "branch_id": 21123
            }
        },
        {
            "action_name": "assign_users",
            "value": [
                461258256,
                1968921873
            ]
        },
        {
            "action_name": "assign_tags",
            "value": [
                "new tag",
                "tag 3"
            ]
        }
    ],
    "filters": {
        "order_ids": [
            1296837389,
            1936133132
        ],
        "order_status": [
            3,
            5
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.salla.dev/admin/v2/orders/actions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operations": [
        {
            "action_name": "print_prepare_list"
        },
        {
            "action_name": "change_status",
            "value": {
                "status": 525144736,
                "send_status_sms": true,
                "return_police": true,
                "restore_items": true,
                "note": "one note",
                "branch_id": 21123
            }
        },
        {
            "action_name": "assign_users",
            "value": [
                461258256,
                1968921873
            ]
        },
        {
            "action_name": "assign_tags",
            "value": [
                "new tag",
                "tag 3"
            ]
        }
    ],
    "filters": {
        "order_ids": [
            1296837389,
            1936133132
        ],
        "order_status": [
            3,
            5
        ]
    }
}'

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 (BulkActions) {4}]

optional

operation_id

string

required

A unique identifier assigned to a specific operation or task within a system.

action_name

enum<string>

required

Action name

Allowed values:

create_shipping_policyprint_shipping_policyassign_usersexportassign_tagschange_statusprint_prepare_listdeleterefund

status

string

required

Action performed status

message

string

required

In the case of action failure, textual message will appear

Example

{
    "status": 200,
    "success": true,
    "data": [
        {
            "operation_id": "9c248334-f4cb-491b-84d0-57c415347d34",
            "action_name": "print_prepare_list",
            "status": "in_progress"
        },
        {
            "operation_id": "9c248334-f4cb-491b-84d0-57c415347dd5",
            "action_name": "change_status",
            "status": "in_progress"
        },
        {
            "operation_id": "9c248336-0080-440f-a936-68ee195e4139",
            "action_name": "assign_users",
            "status": "success"
        },
        {
            "operation_id": "9c1ab67e-fd53-47da-a4d1-12cd69f7b656",
            "action_name": "assign_tags",
            "status": "failed",
            "message": "لم يتم العثور على التاقات "
        }
    ]
}

🟠422Error Validation

🟠401Unauthorized