Create Document Shipment
POST
/api/v1/shipment/shipments/documents
Creates a document shipment and registers it with UPS. The carrier is always UPS Express Saver (carrierId 1); a single package is created (0 × 0 × 0 cm, 0.5 kg). If the operation cannot be completed, the shipment stays in the panel as a draft (Not generated); a new attempt without id creates a new draft.
Parameters
Header Parameters
Authorization*
Token returned by the Get Token request, with the Bearer prefix
Typestring
RequiredExample
"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.signature"Accept-Language
Language of the name fields in the response (country, unit of measure, status and package additional fee names) and of validation messages. English when it starts with en (e.g. en, en-US), Turkish otherwise. Success, business rule, authorization and 503 messages are always in Turkish.
Typestring
Examples
"tr""en"Default
"tr"Request Body
application/json
JSON
{
"recipientAddress": {
"countryId": 3,
"firstName": "JOHN",
"lastName": "DOE",
"company": "",
"email": "",
"phone": "2125550100",
"zipCode": "10001",
"state": "NY",
"city": "NEW YORK",
"address1": "350 5TH AVE",
"address2": ""
},
"referenceNumbers": [
"REF1"
],
"isRecipientCompany": false,
"taxIdentificationNumber": "",
"senderAddressId": 12,
"id": 2257
}
Responses
Document shipment created
application/json
JSON
{
"success": true,
"message": "Döküman gönderisi oluşturuldu",
"data": {
"id": 0,
"barcode": "string",
"trackingNumber": "string",
"trackingUrl": "string",
"description": "string",
"comment": "string",
"type": {
"id": 0,
"slug": "string",
"name": "string"
},
"status": {
"id": 0,
"slug": "string",
"name": "string"
},
"activityStatus": {
"id": 0,
"slug": "string",
"name": "string"
},
"currency": {
"id": 0,
"code": "string",
"name": "string"
},
"exportCode": {
"id": 0,
"code": "string",
"name": "string"
},
"carrier": {
"id": 0,
"slug": "string",
"name": "string",
"service": "string",
"logoUrl": "string"
},
"organization": {
"id": 0,
"name": "string"
},
"singlePointImport": {
"id": 0,
"name": "string",
"upsShipmentId": "string"
},
"recipientAddress": {
"id": 0,
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "string",
"phone": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"address1": "string",
"address2": "string",
"country": {
"id": 0,
"code": "string",
"name": "string",
"flags": {
"w20": "string",
"w40": "string"
},
"phoneCode": "string",
"isUpsService": true,
"tax": {
"type": "string",
"maxValidPrice": 0
}
}
},
"senderAddress": {
"id": 0,
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "string",
"phone": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"address1": "string",
"address2": "string",
"country": {
"id": 0,
"code": "string",
"name": "string",
"flags": {
"w20": "string",
"w40": "string"
},
"phoneCode": "string",
"isUpsService": true,
"tax": {
"type": "string",
"maxValidPrice": 0
}
}
},
"billingAddress": {
"id": 0,
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "string",
"phone": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"address1": "string",
"address2": "string",
"country": {
"id": 0,
"code": "string",
"name": "string",
"flags": {
"w20": "string",
"w40": "string"
},
"phoneCode": "string",
"isUpsService": true,
"tax": {
"type": "string",
"maxValidPrice": 0
}
}
},
"referenceNumbers": [
"string"
],
"taxIdentificationNumber": "string",
"deliveryTaxType": 0,
"previousTaxStatus": 0,
"isGuarantee": true,
"isOutsource": true,
"customsAccountNumber": "string",
"customsAccountZipCode": "string",
"packages": [
{
"id": 0,
"desi": 0,
"size": 0,
"height": 0,
"length": 0,
"weight": 0,
"trackingNumber": "string",
"activityStatus": {
"id": 0,
"slug": "string",
"name": "string"
}
}
],
"products": [
{
"id": 0,
"hsCode": "string",
"description": "string",
"piece": 0,
"unitPrice": 0,
"unitOfMeasure": {
"id": 0,
"code": "string",
"name": "string"
},
"originCountry": {
"id": 0,
"code": "string",
"name": "string"
}
}
],
"createdAt": "string",
"updatedAt": "string"
}
}