Add Document
POST
/api/consignment/document
Parameters
Header Parameters
Authorization*
API key
Typestring
RequiredExample
"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30"Request Body
application/json
JSON
{
"organizationId": null,
"recipientAddress": {
"firstName": "",
"lastName": "",
"company": "",
"email": "",
"phone": "",
"countryId": 3,
"zipCode": "",
"state": "",
"city": "",
"address1": "",
"address2": ""
},
"referenceNumbers": [
"REF1"
],
"isRecipientCompany": true,
"taxIdentificationNumber": ""
}
Responses
Document Created Successfully
application/json
JSON
{
"id": 2257,
"type": {
"id": 1,
"slug": "DOCUMENT",
"name": "Document"
},
"status": {
"id": 2,
"slug": "ADDED_UPS",
"name": "Created"
},
"createdAt": "2026-02-03T07:34:54+00:00",
"updatedAt": "2026-02-03T07:34:54+00:00",
"trackingNumber": "1ZXXXXXXXXXXXX244F",
"barcode": "2602324186",
"trackingUrl": "https://www.ups.com/track?loc=tr_TR&requester=ST/trackdetails&tracknum=1ZXXXXXXXXXXXX244F",
"packages": [
{
"id": 8862,
"desi": 0.5,
"trackingNumber": "1ZXXXXXXXXXXXX244F",
"activityStatus": {
"id": 0,
"slug": "string",
"name": "string"
}
}
],
"recipientAddress": {
"id": 4292,
"firstName": "ASKIN",
"lastName": "OKAN",
"company": "",
"country": {
"id": 3,
"code": "US",
"name": "United States"
}
},
"senderAddress": {
"id": 4293,
"firstName": "AHMET",
"lastName": "AYDOGDU",
"company": "GOOGLE",
"country": {
"id": 234,
"code": "TR",
"name": "Turkey"
}
},
"organization": {
"id": 1,
"name": "ABC"
},
"carrier": {
"id": 1,
"name": "UPS",
"service": "Express Saver",
"slug": "UPS_SAVER"
},
"freightPrice": 9.97,
"peakPrice": 0.25,
"remoteAreaPrice": 0,
"referenceNumbers": [
"12"
],
"currency": null,
"taxNumber": null,
"taxIdentificationNumber": null,
"billingAddress": null,
"orderData": null,
"comment": null,
"isGuarantee": false,
"isOutsource": false,
"singlePointImport": null,
"products": [
],
"customsAccountNumber": null
}