This API is used by Delivery partners to update delivery status
| Attachment | Size |
|---|---|
 Postman Collection | 2.09 KB |
Response Codes
Click Here for API Response Codes
Basepath
/v2
API Developer
production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/update/awb/{awb_number}
post /update/awb/{awb_number}
This is used to update Status of the delivery for the AWB.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/rb/api/v1/partner_auth/token
Scopes
update_awb
awb_number
Required in path
string
AWB Number returned in the AWB Generation API response.
{
"maxLength": 30
}update_awb
Required in body
object
additional details of the application
channelid
Required in header
string
Channel Id
{
"maxLength": 20
}msgid
Required in header
string
Unique Id sent by client. Value should be a unique identifier of the request in UUID format.
{
"maxLength": 50
}Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
401
Unauthorized
403
Forbidden
422
Error
500
Internal Server Error
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/update/awb/{awb_number}
Definitions
Response in case of error
{
"properties": {
"response_code": {
"type": "string",
"description": "API specific error code"
},
"response_message": {
"type": "string",
"description": "breif details of the error"
},
"status": {
"type": "string",
"description": "HTTP Status"
},
"description": {
"type": "string",
"description": "detailed description of the error"
},
"property": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"response_code",
"response_message",
"status"
]
}
{
"properties": {
"document_name": {
"type": "string",
"description": "For POD & Single Pager document",
"maxLength": 100
},
"document_type": {
"type": "string",
"description": "Possible values: jpg, png",
"maxLength": 50
},
"Document_url": {
"type": "string",
"description": "URL of a uploaded image"
}
},
"additionalProperties": false
}
{
"properties": {
"emirates_id_ping_data": {
"$ref": "#/definitions/emirates_id_ping_data"
},
"delivery_status": {
"type": "string",
"description": "Delivery status",
"maxLength": 70
},
"status_code": {
"type": "string",
"description": "Status code",
"maxLength": 10
},
"documents": {
"type": "array",
"items": {
"$ref": "#/definitions/documents"
},
"description": "Array of documents"
}
},
"additionalProperties": false,
"required": [
"status_code"
]
}
{
"properties": {
"awb_number": {
"type": "string",
"description": "AWB Number returned in the AWB Generation API response."
}
},
"additionalProperties": false
}
{
"properties": {
"emirates_id": {
"type": "string",
"description": "Emirates Id",
"example": "784197772697591",
"maxLength": 20
},
"expiry_date": {
"type": "string",
"description": "Emirates Id expiry date",
"example": "2031-10-17",
"maxLength": 10
},
"card_number": {
"type": "string",
"description": "Card number",
"example": "10000000",
"maxLength": 20
},
"date_of_birth": {
"type": "string",
"description": "Date of birth",
"example": "2031-10-17",
"maxLength": 10
},
"gender": {
"type": "string",
"description": "gender",
"example": "M",
"maxLength": 10
},
"name_english": {
"type": "string",
"description": "Name in English",
"example": "Jhon Smith",
"maxLength": 80
},
"nationality": {
"type": "string",
"description": "Nationality in English",
"example": "India",
"maxLength": 50
}
},
"additionalProperties": false,
"required": [
"emirates_id",
"gender",
"name_english"
]
}