Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Order Items
  • Welcome 👋
  • Get Started
  • Create Your First App
  • Authorization
  • Webhooks
  • Conditional Webhooks
  • Security Considerations
  • Multi-Language Support
  • Responses
  • Pagination
  • Rate Limiting
  • Versioning
  • Change Log
  • Support
  • APIs
    • Orders
      • Create Order
      • List Orders
      • Order Details
      • Create Drafted Order
      • Update Order
      • Duplicate Order
      • Order Actions
    • Order Status
      • Update Order Status
      • Create Custom Order Status
      • List Order Statuses
      • Order Status Details
      • Update Custom Order Status
      • Update Bulk Orders Statuses
      • Sort Orders Statuses
    • Order Histories
      • List Order Histories
      • Create Order History
    • Order Tags
      • Create Order Tag
      • List Order Tags
      • Delete Order Tag
    • Order Invoice
      • Create Invoice
      • List Invoices
      • Invoice Details
      • Send Order Invoice
      • Create Order Invoice
    • Order Reservations
      • List Order Reservations
    • Order Items
      • List Order Items
        GET
      • Create Order Item
        POST
      • Update Order Item
        PUT
      • Delete Order Item
        DELETE
    • Products
      • Create Product
      • List Products
      • Product Details
      • Update Product
      • Delete Product
      • Change Product Status
      • Product Details By SKU
      • Update Product By SKU
      • Delete Product By SKU
      • Update Product Price By SKU
      • Update Bulk Product Prices
      • Import Products
      • Bulk Product Actions
    • Product Options
      • Create Product Option
      • Product Option Details
      • Update Product Option
      • Delete Product Option
    • Product Quantity
      • List Product Quantities
      • Update Bulk Quantities
      • List Quantity Change Reasons
      • List Quantity Audit
      • Update Bulk Quantities by SKU
      • Update Quantity
      • Update Quantity By SKU
    • Product Variants
      • List Product Variants
      • Product Variant Details
      • Update Product Variant
      • Update Product Variant Quantity
    • Product Tags
      • Create Product Tag
      • List Product Tags
    • Product Images
      • Attach Image by SKU
      • Attach Video by SKU
      • Attach Youtube Video
      • Attach Image
      • Update Image
      • Delete Image
    • Product Option Values
      • Create Product Option Value
      • Product Option Value Details
      • Update Product Option Value
      • Delete Product Option Value
    • Abandoned Carts
      • List Abandoned Carts
      • Abandoned Cart Details
    • Customer Groups
      • Create Customer Group
      • List Customer Groups
      • Add Customers To Group Customer
      • Update Default Customer Group
      • Update Customer Group
      • Delete Customer Group
    • Customers
      • Create Customer
      • List Customers
      • Customer Details
      • Update Customer
      • Delete Customer
      • Ban Customer
      • Un-Ban customer
      • Import Customers
    • Digitals Product
      • Attach Digital Code
      • Attach Digital File
      • Delete Digital File
    • Categories
      • Create Category
      • List Categories
      • Category Details
      • Update Category
      • Delete Category
      • Category Children
      • Categories Search
      • List Category Products
    • Exports
      • Export Orders
      • Exports Logs
      • List Export Templates
      • Create Export Template
      • Update Export Template
      • Delete Export Template
      • List Export Columns
      • Export Customers
      • Export Custom URLs
      • Export Products
    • Shipments
      • Create Shipment
      • List Shipments
      • Shipment Details
      • Shipment Tracking
      • Update Shipment Details
      • Cancel Shipment
      • Return Shipment
    • Shipping Companies
      • List Shipping Companies
      • Shipping Company Details
      • List Estimate Rates
      • Create Shipping Company
      • Update Shipping Company
      • Delete Shipping Company
      • Shipping Company Options
    • Shipping Zones
      • Create Shipping Zone
      • List Shipping Zones
      • Shipping Zone Details
      • Update Shipping Zone
      • Delete Shipping Zone
    • Shipping Rules
      • List Shipping Rules
      • Shipping Rule Details
      • Delete Shipping Rule
    • Countries
      • List Countries
      • Country Details
    • Product Option Templates
      • List Option Templates
      • Option Template Details
      • Delete Option Template
      • Update Option Template
      • Create Option Template
    • Taxes
      • Create Tax
      • List Taxes
      • Tax Details
      • Update Tax
      • Delete Tax
    • Coupons
      • Create Coupon
      • List Coupons
      • Coupon Details
      • Update Coupon
      • Delete Coupon
      • List Coupon Codes
    • Affiliates
      • List Affiliates
      • Affiliate Details
      • Create Affiliate
      • Update Affiliate
      • Delete Affiliate
    • Order Assignment
      • List Auto Assignment Rules
      • Order Assigned Employees Details
      • Update Auto Assignment Rule
      • Create Auto Assignment Rules
    • Special Offers
      • Create Special Offer
      • List Special Offers
      • Special Offer Details
      • Update Special Offer
      • Delete Special Offer
      • Change Special Offer Status
    • Transactions
      • List Transactions
      • Transaction Details
      • Update Transaction
    • Payments
      • Available Payment Methods
      • List Banks
      • Payment Bank Details
    • Settlements
      • List Instant Settlements
      • Create Instant Settlement
      • Update Instant Settlement
      • Instant Settlement Details
    • Settings
      • Settings List
      • Update Setting Slug
      • Setting Details
    • Merchant
      • User Information Details
      • Store Information
    • Brands
      • Create Brand
      • List Brands
      • Brand Details
      • Update Brand
      • Delete Brand
    • Branches
      • Create Branch
      • List Branches
      • Branch Details
      • Update Branch
      • Delete Branch
    • Currencies
      • Activate Currencies
      • List Currencies
      • List Available Currencies
    • SEO
      • List SEO Settings
      • Update SEO Settings
    • Cities
      • List Cities
    • DNS Records
      • List DNS Records
      • Create DNS Record
      • Delete DNS Record
    • Languages
      • Add Language
      • List Languages
      • Update Language
    • Employees
      • List Employees
    • Advertisements
      • Create Advertisement
      • List Advertisements
      • Advertisement Details
      • Update Advertisement
      • Delete Advertisement
    • Webhooks
      • List Active Webhooks
      • List Events
      • Register Webhook
      • Deactivate Webhook
      • Update Webhook
    • Custom URLs
      • Import Custom URLs
    • Loyalty Points
      • Customer Loyalty Points
      • Update Customer Loyalty Points
    • Reviews
      • List Reviews
      • Review Details
      • Update Review
  • Webhooks - Store Events
    • Order
    • Product
    • Customer
    • Shippings
    • Shipments
    • Brand
    • Invoice
    • Category
    • Store
    • Special Offer
    • Cart
    • Miscellaneous
  1. Order Items

Create Order Item

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
POST
https://api.salla.dev/admin/v2
/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

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
id
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.
Example
{
  "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,
  "cost_price": 80,
  "weight": 150,
  "weight_type": "g"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request 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"
}'

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
id
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
Example
{
  "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": []
    }
  ]
}
🟠404Not Found
🟠401Unauthorized
Modified at 2024-12-29 06:40:32
Previous
List Order Items
Next
Update Order Item