[lightMode]

Invoice Details

GET/orders/invoices/{invoice_id}

[updatedIn] 2 months ago

This endpoint allows you to fetch a specific order invoice details by passing the invoice_id as a path parameter.

`orders.read` - Orders Read Only

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

[message.pathParameter]

invoice_id

integer

required

Invoice ID. List of Invoice ID can be found here

Example:

673490471

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": 1128904162,
    "invoice_number": "1",
    "uuid": null,
    "order_id": 1152394206,
    "invoice_reference_id": null,
    "type": "Tax Invoice",
    "date": "2022-06-30",
    "qr_code": null,
    "payment_method": "bank",
    "sub_total": {
      "amount": 130,
      "currency": "SAR"
    },
    "shipping_cost": {
      "amount": 23,
      "taxable": true,
      "currency": "SAR"
    },
    "cod_cost": {
      "amount": 0,
      "taxable": true,
      "currency": "SAR"
    },
    "discount": {
      "amount": 0,
      "currency": "SAR"
    },
    "tax": {
      "percent": 0,
      "amount": {
        "amount": 0,
        "currency": "SAR"
      }
    },
    "total": {
      "amount": 153,
      "currency": "SAR"
    },
    "items": [
      {
        "id": 1670203268,
        "product_id": "977135276",
        "item_id": 588287185,
        "name": "شاحن آنكر 1000",
        "quantity": 1,
        "type": "product",
        "price": {
          "amount": 130,
          "currency": "SAR"
        },
        "discount": {
          "amount": 0,
          "currency": "SAR"
        },
        "tax": {
          "percent": 0,
          "amount": {
            "amount": 0,
            "currency": "SAR"
          }
        },
        "total": {
          "amount": 130,
          "currency": "SAR"
        }
      }
    ]
  }
}

[updatedIn] 2 months ago