[lightMode]

Send Order Invoice

POST/orders/{order_id}/send-invoice

[updatedIn] 2 months ago

This endpoint allows you to send the order invoice to the customer's email by passing the order_id as a path parameter.

:::tip[Note]
To send the invoice, the email address should be recorded on the invoice.
:::

`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

[message.pathParameter]

order_id

number

required

A unique alphanumeric code or identifier assigned to a specific order. List of Order ID can be found here

Example:

289032373

Request samples

[api.label.responses]

Success(200)

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

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

{
  "status": 200,
  "success": true,
  "data": {
    "message": "تم ارسال رسالة الفاتورة بنجاح"
  }
}

[updatedIn] 2 months ago