Skip to content
KasblyKasbly Docs

Update customs invoice

PATCH
/api/v1/orders/{id}/customs-invoice
curl --request PATCH \
  --url https://api.dokanmazad.com/api/v1/orders/cmosor2zy000313ny24hgtfy0/customs-invoice \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "buyerName": "Ahmed Ali", "buyerAddress": "123 Main St, Dubai, UAE", "buyerPhone": "+971501234567", "carMake": "BMW", "carModel": "3 Series", "carYear": 2023, "carVin": "WBAXH1C50DD123456", "carColor": "Alpine White", "items": [ { "description": "Vehicle price", "amount": 25000 } ], "currency": "USD", "language": "en" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Order ID (CUID)

Example
cmosor2zy000313ny24hgtfy0

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
buyerName
required

Buyer full name

string
buyerAddress

Buyer address

string
buyerPhone

Buyer phone number

string
carMake

Car make

string
carModel

Car model

string
carYear

Car manufacture year

number
carVin

VIN / chassis number

string
carColor

Car color

string
items
required

Line items — each has description and amount

Array
currency
required

Currency — USD | SAR | KRW | AED

string
notes

Optional internal notes

string
language

Invoice language — en | ar

string
Examples
Exampledefault
{
  "buyerName": "Ahmed Ali",
  "buyerAddress": "123 Main St, Dubai, UAE",
  "buyerPhone": "+971501234567",
  "carMake": "BMW",
  "carModel": "3 Series",
  "carYear": 2023,
  "carVin": "WBAXH1C50DD123456",
  "carColor": "Alpine White",
  "items": [
    {
      "description": "Vehicle price",
      "amount": 25000
    }
  ],
  "currency": "USD",
  "language": "en"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
success
required
boolean
data
required
meta
object
page
integer
limit
integer
total
integer
totalPages
integer
data
required
object
id
required

Order ID

string
customsInvoice

Stored customs invoice JSON

object
updatedAt
required

Last updated

string format: date-time
Examples
Examplesuccess
{
  "success": true,
  "data": {
    "id": "cmosor2zy000313ny24hgtfy0",
    "customsInvoice": {
      "buyerName": "Ahmed Ali",
      "buyerAddress": "123 Main St, Dubai, UAE",
      "carMake": "BMW",
      "carModel": "3 Series",
      "carYear": 2023,
      "items": [
        {
          "description": "Vehicle price",
          "amount": 25000
        }
      ],
      "currency": "USD"
    },
    "updatedAt": "2026-05-10T14:00:00.000Z"
  }
}

401

Section titled “401”

Unauthorized — missing or invalid API key

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
  "success": false
}

403

Section titled “403”

Forbidden — route not in this key’s allowedRoutes

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
  "success": false
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
  "success": false
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying