Skip to main content
POST
/
v1
/
orders
/
{orderUuid}
/
complete
Complete an order checkout
curl --request POST \
  --url https://api.papp.sa/api/v1/orders/{orderUuid}/complete \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payment_method": "2"
}
'
{
  "status": true,
  "message": "",
  "appended_data": {},
  "data": {
    "id": 42,
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "reference_number": "REF-2024-001234",
    "order_status": "approved",
    "order_number": "ORD-2024-001234",
    "type": 1,
    "total_price": 150.5,
    "total_points": 1505,
    "metadata": {
      "source": "mobile_app"
    },
    "date": "2024-12-23T00:00:00.000Z",
    "time": "10:00:00",
    "since": "2 hours ago",
    "created_at": "2024-12-23T10:00:00.000Z",
    "items": [
      {
        "product_name": "Cappuccino",
        "product_price": 18.5,
        "quantity": 2
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

orderUuid
string<uuid>
required

Order UUID.

Body

application/json

Body for POST /v1/orders/{orderUuid}/complete. All fields are optional.

payment_method
enum<string> | null

Payment method used to complete the order. String-numeric enum:

ValueMethod
"1"VISA
"2"MADA
"3"Apple Pay
"4"Mastercard
"5"Tabby
"6"Dashboard
"7"Bank transfer
"8"Wallet
"9"Cash
"10"Tamara
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
Example:

"2"

Response

Order completed successfully.

status
boolean
required
Example:

true

message
string | null
required
Example:

""

appended_data
object
required
Example:
{}
data
object
required