[lightMode]

List Invoices

GET/orders/invoices

[updatedIn] 2 months ago

This endpoint allows you to fetch a list of order invoices.

`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.queryParameter]

from_date

string

optional

Invoice Date Range (from)

to_date

string

optional

Invoice Date Range (to)

order_id

integer

optional

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

Request samples

[api.label.responses]

Success(200)

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

array[object (Invoice) {15}]

optional

number

required

A unique alphanumeric code or identifier assigned to a specific invoice. Invoice list can be found here

Example:

458282634

invoice_number

string

required

The invoice number as in the order.

uuid

string <uuid>

required

Another unique identifier of the invoice

Example:

e7f9e1e3-90d1-487d-afe1-f97e10b80b1d

order_id

integer

required

A unique alphanumeric code or identifier assigned to a specific order.

Example:

1557892161

invoice_reference_id

string

required

A unique alphanumeric code or identifier assigned to aninvoice. This is especially used if the invoice is issued outside Salla system.

type

string

required

Invoice Type.

Example:

Credit Note

date

string

required

Invoice Date.

Example:

2022-01-19

qr_code

string

required

Invoice QR code.

payment_method

string

required

Invoice payment method.

sub_total

object

required

Invoice sub total.

shipping_cost

object

required

Invoice shipping cost.

cod_cost

object

required

Cash on delivery cost.

discount

object

required

Discount applied on the invoice.

tax

object

required

Tax applied on the invoice.

total

object

required

Invoice total.

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1479538730,
      "order_id": 1557892161,
      "type": "Credit Note",
      "sub_total": {
        "amount": "1000.00",
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": "10.00",
        "currency": "SAR"
      },
      "cod_cost": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "discount": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": "151.50",
          "currency": "SAR"
        }
      },
      "total": {
        "amount": 1161.5,
        "currency": "SAR"
      },
      "date": "2021-12-03"
    },
    {
      "id": 1692688589,
      "order_id": 1557892161,
      "type": "Tax Invoice",
      "sub_total": {
        "amount": "29.00",
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": "10.00",
        "currency": "SAR"
      },
      "cod_cost": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "discount": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": "5.85",
          "currency": "SAR"
        }
      },
      "total": {
        "amount": 44.85,
        "currency": "SAR"
      },
      "date": "2021-12-03"
    },
    {
      "id": 1219192926,
      "order_id": 1557892161,
      "type": "Tax Invoice",
      "sub_total": {
        "amount": "850.00",
        "currency": "SAR"
      },
      "shipping_cost": {
        "amount": "25.00",
        "currency": "SAR"
      },
      "cod_cost": {
        "amount": "10.00",
        "currency": "SAR"
      },
      "discount": {
        "amount": "0.00",
        "currency": "SAR"
      },
      "tax": {
        "percent": "15.00",
        "amount": {
          "amount": "132.75",
          "currency": "SAR"
        }
      },
      "total": {
        "amount": 1017.75,
        "currency": "SAR"
      },
      "date": "2021-12-04"
    }
  ],
  "pagination": {
    "count": 3,
    "total": 3,
    "perPage": 3,
    "currentPage": 1,
    "totalPages": 1,
    "links": {
      "next": null
    }
  }
}

[updatedIn] 2 months ago