[lightMode]

Create Invoice

POST/orders/invoices

[updatedIn] 2 months ago

This endpoint allows you to create an invoice to a specific order from your side.

:::tip[Note]
For the order data type, you will need to specify the Invoice issuance to be from Salla.
However, for the other data types available, such as data, url, and file, you will need to set it to custom from the Store Settings.
:::

`orders.read_write` - Orders Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

order_id

integer

required

Order ID. List of Order IDs can be found here

Example:

1818813486

type

enum<string>

required

Invoice Type. Note that you cannot create a credit_note invoice type before creating a tax_invoice type

Allowed values:

tax_invoicecredit_note

Example:

tax_invoice

data_type

enum<string>

required

Invoice Data Type.

Allowed values:

dataurlfileorder

Example:

data

url

string

optional

URL Link to the PDF file. The variable is requiredif data_type is url.

Example:

https://i.ibb.co/jyqRQfQ/invoice.pdf

invoice_number

string | integer

optional

Invoice Number. The variable is requiredif data_type is data.

Example:

2sdfs435d

sub_total

number

optional

Invoice Subtotal Cost. The variable is requiredif data_type is data.

Example:

999

total

number

optional

Invoice Total Cost. The variable is requiredif data_type is data.

Example:

7789

shipping_cost

number

optional

Invoice Shipping Cost. The variable is requiredif data_type is data.

Example:

cash_on_delivery_cost

number

optional

Invoice COD Cost. The variable is requiredif data_type is data.

Example:

789

tax

number

optional

Tax Cost Percentage. The variable is requiredif data_type is data.

Example:

tax_value

integer

optional

Tax Value Cost. The variable is requiredif data_type is data.

Example:

35.3

{
  "order_id": 1818813486,
  "type": "tax_invoice",
  "data_type": "data",
  "url": "https://i.ibb.co/jyqRQfQ/invoice.pdf",
  "invoice_number": "2sdfs435d",
  "sub_total": 999,
  "total": 7789,
  "shipping_cost": 78,
  "cash_on_delivery_cost": 789,
  "tax": 10,
  "tax_value": 35.3
}

Request samples

[api.label.responses]

Success(200)

Not Found(404)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

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 ( InvoiceDetails)

optional

number

required

A unique identifier of the invoice

Example:

454902145

invoice_number

string

required

The invoice number as in the order

Example:

uuid

string <uuid>

required

Another unique identifier of the invoice

Example:

e7f9e1e3-90d1-487d-afe1-f97e10b80b1d

order_id

number

required

A unique identifier assigned to the order. List of orders can be found here.

invoice_reference_id

string | null

required

Invoice reference. This is especially used if the invoice is issued outside Salla system

type

string

required

Invoice Type

Example:

Tax Invoice

date

string

required

Invoice issuance date

Example:

2023-10-01

qr_code

string | null

required

Invoice QR code

payment_method

string

required

Invoice payment method

Example:

credit_card

subtotal

object

required

shipping_cost

object

required

cod_cost

object

required

discount

object

required

tax

object

required

total

object

required

items

array [object {10}]

required

Invoice items details.

{
  "status": 200,
  "success": true,
  "data": {
    "id": 1333835642,
    "order_id": 1371877152,
    "type": "Tax Invoice",
    "invoice_number": "2sdfs435d",
    "sub_total": {
      "amount": 999,
      "currency": "ر.س"
    },
    "shipping_cost": {
      "amount": 78,
      "currency": "ر.س"
    },
    "cod_cost": {
      "amount": 789,
      "currency": "ر.س"
    },
    "discount": {
      "amount": 0,
      "currency": "ر.س"
    },
    "tax": {
      "percent": 10,
      "amount": {
        "amount": 35.3,
        "currency": "ر.س"
      }
    },
    "total": {
      "amount": 7789,
      "currency": "ر.س"
    },
    "date": "2022-03-23",
    "items": [
      {
        "name": "فستان فراولة",
        "quantity": 1,
        "price": {
          "amount": "90.50",
          "currency": "SAR"
        },
        "discount": {
          "amount": "0.00",
          "currency": "SAR"
        },
        "tax": {
          "percent": "15.00",
          "amount": {
            "amount": "13.58",
            "currency": "SAR"
          }
        },
        "total": {
          "amount": 104.08,
          "currency": "SAR"
        }
      }
    ]
  }
}

[updatedIn] 2 months ago