Skip to content

⚠️ Deprecated

This endpoint is deprecated and will be removed in the future. Use its API v1 equivalent for new integrations.

Deprecated

Create Package Advance​

POST
/api/consignment/package/advance

Creates a package consignment and registers it with UPS. Requires the SHIPMENTS permission. For consignments outside single point import, the sender address tax information (tax type and the matching Turkish ID or tax number) must be complete; otherwise 406 is returned. Tax information is not required when ZEMLOG defined a custom carrier address for the organization. The consignment is first saved as a draft; if the UPS or charge step fails it stays in the panel as a draft (Not generated), and a new attempt without id creates a new draft.

Parameters​

Header Parameters

Authorization*

API key

Typestring
Required
Example"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30"
Accept-Language

Response language: tr or en. Sets error messages and language-dependent texts; tr is used when no recognized language is given.

Typestring
Examples
"tr"
"en"

Request Body​

application/json
JSON
{
"id": 0,
"senderAddressId": 0,
"newSenderAddress": {
"title": "TTTT",
"firstName": "TIRTIR",
"lastName": "UNLU",
"company": "",
"phone": "0538234503",
"email": "",
"address1": "ASDAF DFH FFGFSD ERDFSV",
"address2": " NO 7 DAIRE 6",
"zipCode": "1111111",
"taxType": 1,
"city": {
"id": 34,
"name": "ISTANBUL"
},
"county": {
"id": 268,
"name": "KADIKOY"
},
"tcNo": "11111111111",
"taxNumber": "string"
},
"description": "ACIKLAMA",
"comment": "",
"referenceNumbers": [
"REF1"
],
"carrierId": 1,
"packages": [
{
"length": 10,
"size": 10,
"height": 10,
"weight": 10,
"piece": 1
}
],
"taxNumber": "",
"currencyId": 1,
"exportCodeId": 10,
"products": [
{
"description": "ACIKLAMA",
"hsCode": "121212",
"piece": 1,
"unitPrice": 10,
"originCountryCode": "US",
"unitOfMeasure": {
"code": "PCS",
"name": "Piece / Unit"
}
}
],
"freight": 0,
"discount": 0,
"other": 0,
"isRecipientCompany": false,
"taxIdentificationNumber": "",
"deliveryTaxType": 0,
"previousTaxStatus": 0,
"customsAccountNumber": "string",
"customsAccountZipCode": "string",
"recipientAddress": {
"firstName": "SELMA",
"lastName": "FAZLIC",
"company": "",
"email": "",
"phone": "1111111111",
"countryId": 3,
"zipCode": "840477865",
"state": "UT",
"city": "MIDVALE",
"address1": "8355 S SKY MIRROR LN M 101",
"address2": ""
},
"singlePointImportId": 12,
"isDiffBillingAddress": false,
"billingAddress": {
"firstName": "SELMA",
"lastName": "FAZLIC",
"company": "",
"email": "",
"phone": "1111111111",
"countryId": 3,
"zipCode": "840477865",
"state": "UT",
"city": "MIDVALE",
"address1": "8355 S SKY MIRROR LN M 101",
"address2": ""
}
}

Responses​

Consignment Package Advanced Successfully

application/json
JSON
{
"id": 0,
"type": {
"id": 0,
"slug": "string",
"name": "string"
},
"status": {
"id": 0,
"slug": "string",
"name": "string"
},
"createdAt": "string",
"updatedAt": "string",
"currency": {
"id": 0,
"name": "string",
"code": "string",
"updatedAt": "string"
},
"exportCode": {
"id": 0,
"code": "string",
"name": "string"
},
"trackingNumber": "string",
"barcode": "string",
"trackingUrl": "string",
"description": "string",
"packages": [
{
"id": 0,
"desi": 0,
"size": 0,
"height": 0,
"length": 0,
"weight": 0,
"trackingNumber": "string",
"activityStatus": {
"id": 0,
"slug": "string",
"name": "string"
}
}
],
"activityStatus": {
"id": 0,
"slug": "string",
"name": "string"
},
"recipientAddress": {
"id": 0,
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "string",
"country": {
"id": 0,
"code": "string",
"name": "string",
"phoneCode": "string",
"isUpsService": true,
"taxType": "string",
"taxMaxValidPrice": 0,
"flagW40": "string",
"flagW20": "string"
},
"phone": "string",
"zipCode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string"
},
"senderAddress": {
"id": 0,
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "string",
"country": {
"id": 0,
"code": "string",
"name": "string",
"phoneCode": "string",
"isUpsService": true,
"taxType": "string",
"taxMaxValidPrice": 0,
"flagW40": "string",
"flagW20": "string"
},
"phone": "string",
"zipCode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string"
},
"referenceNumbers": [
"string"
],
"taxIdentificationNumber": "string",
"deliveryTaxType": 0,
"previousTaxStatus": 0,
"billingAddress": {
"id": 0,
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "string",
"country": {
"id": 0,
"code": "string",
"name": "string",
"phoneCode": "string",
"isUpsService": true,
"taxType": "string",
"taxMaxValidPrice": 0,
"flagW40": "string",
"flagW20": "string"
},
"phone": "string",
"zipCode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string"
},
"orderData": null,
"comment": "string",
"isGuarantee": true,
"isOutsource": true,
"organization": {
"id": 0,
"name": "string"
},
"singlePointImport": {
"id": 0,
"name": "string",
"shipmentId": "string"
},
"products": [
{
"id": 0,
"hsCode": "string",
"description": "string",
"piece": 0,
"unitPrice": 0,
"unitOfMeasure": {
"id": 0,
"name": "string",
"code": "string"
},
"originCountry": {
"id": 0,
"code": "string",
"name": "string"
}
}
],
"carrier": {
"id": 0,
"name": "string",
"service": "string",
"slug": "string",
"logoUrl": "string"
},
"customsAccountNumber": "string",
"customsAccountZipCode": "string"
}

Playground​

Headers
Body

Samples​

cURL
JavaScript
PHP
Python