axiomus
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][pointAddress] |
string |
deprecated Pickup point address |
order[delivery][data][externalId] |
string |
deprecated Track number |
order[delivery][data][okey] |
string |
Axiomus delivery ID |
order[delivery][data][statusCode] |
string |
deprecated Delivery status code |
order[delivery][data][deliveryType] |
string |
Delivery type (delivery , carry , post , dpd , logibox_dpd , boxberry_pickup ) |
order[delivery][data][statusText] |
string |
Delivery status name |
order[delivery][data][schedules] |
string |
Pickup point working time |
order[delivery][data][requestId] |
string |
Request number in Axiomus |
order[delivery][data][price] |
float |
Delivery cost received from delivery service |
Parameter | Type | Description |
---|---|---|
order[delivery][data][deliveryType] |
string |
Delivery type (delivery , carry , post , dpd , logibox_dpd , boxberry_pickup ) |
order[delivery][data][notes] |
string |
Comment to the order |
order[delivery][data][carryPickup] |
string |
Pickup point ID for type "Pickup in region Moscow and St.-Petersburg" |
order[delivery][data][dpdPickup] |
string |
Pickup point ID for type "DPD" |
order[delivery][data][boxberryOfficeCode] |
string |
Pickup point ID for type "BoxBerry pick up" |
courier
Parameter | Type | Description |
---|---|---|
order[delivery][data][id] |
integer |
Courier ID |
order[delivery][data][firstName] |
string |
First name |
order[delivery][data][lastName] |
string |
Last name |
order[delivery][data][patronymic] |
string |
Patronymic |
order[delivery][data][active] |
boolean |
Activity status |
order[delivery][data][email] |
string |
|
order[delivery][data][phone] |
object (CourierPhone) |
Courier phone |
order[delivery][data][phone][number] |
string |
Phone number |
order[delivery][data][description] |
string |
Description |
order[delivery][data][courierId] |
integer |
Courier ID |
Parameter | Type | Description |
---|---|---|
order[delivery][data][courierId] |
integer |
Courier ID |
ddelivery
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][statusText] |
string |
Delivery status name |
order[delivery][data][deliveryName] |
string |
Delivery service name |
order[delivery][data][pickuppointId] |
string |
Pickup point ID (field delivery_point_id in SafeRoute API) |
order[delivery][data][days] |
string |
Approximate delivery time |
order[delivery][data][cost] |
float |
Delivery cost received from delivery service |
order[delivery][data][pickuppoint] |
string |
Pickup point name |
order[delivery][data][pickuppointSchedule] |
string |
Schedule of pickup point |
order[delivery][data][pickuppointDescription] |
string |
Description of pickup point |
order[delivery][data][services][] |
array of strings |
Additional services of delivery |
Parameter | Type | Description |
---|---|---|
order[delivery][data][deliveryType] |
string |
Delivery method ID (field delivery_company_id in SafeRoute API) |
order[delivery][data][pickuppointId] |
string |
Pickup point ID (field delivery_point_id in SafeRoute API) |
order[delivery][data][pickupType] |
integer |
Pickup type (1 - pickup, 2 - courier delivery) |
order[delivery][data][receiverCity] |
string |
Delivery city |
order[delivery][data][receiverCityRef] |
string |
Delivery city ID |
order[delivery][data][placesCount] |
integer |
Seats quantity |
order[delivery][data][services][] |
array of strings |
Additional services of delivery |
order[delivery][data][comment] |
string |
Comment to the order |
dellin
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][payerType] |
string |
Payer (sender , receiver ) |
order[delivery][data][receiverTerminal] |
string |
deprecated Pickup point address |
order[delivery][data][deliveryForm] |
string |
Delivery form (store-store , door-store , store-door , door-door ) |
order[delivery][data][paymentType] |
string |
Payment type |
order[delivery][data][packed] |
string |
Type of package for cargo transferring |
dpd
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][externalId] |
string |
deprecated Track number |
order[delivery][data][statusCode] |
string |
deprecated Delivery status code |
order[delivery][data][statusDate] |
DateTime |
Date of the last delivery status updating |
order[delivery][data][tariffName] |
string |
Tariff name |
order[delivery][data][pickuppointId] |
string |
Pickup point id (field terminalCode in DPD API) |
order[delivery][data][days] |
string |
Approximate delivery time |
order[delivery][data][payerType] |
string |
Payer (sender , receiver ) |
order[delivery][data][receiverCity] |
string |
Delivery city ID in DPD |
order[delivery][data][price] |
float |
Delivery cost received from delivery service |
order[delivery][data][packages][] |
array of objects (DpdPackage) |
Packages |
order[delivery][data][packages][][packageId] |
string |
Package number |
order[delivery][data][packages][][weight] |
double |
Weight |
order[delivery][data][packages][][length] |
integer |
Length |
order[delivery][data][packages][][width] |
integer |
Width |
order[delivery][data][packages][][height] |
integer |
Height |
order[delivery][data][packages][][quantity] |
integer |
Parcel quantity |
order[delivery][data][packages][][number] |
string |
Parcel barcode |
Parameter | Type | Description |
---|---|---|
order[delivery][data][deliveryCode] |
string |
Delivery method ID (field serviceCode in DPD API) |
order[delivery][data][pickuppointId] |
string |
Pickup point id (field terminalCode in DPD API) |
order[delivery][data][receiverCity] |
string |
Delivery city ID in DPD |
order[delivery][data][notes] |
string |
Comment to the order |
order[delivery][data][packages][] |
array of objects (DpdPackage) |
Packages |
order[delivery][data][packages][][packageId] |
string |
Package number |
order[delivery][data][packages][][weight] |
double |
Weight |
order[delivery][data][packages][][length] |
integer |
Length |
order[delivery][data][packages][][width] |
integer |
Width |
order[delivery][data][packages][][height] |
integer |
Height |
order[delivery][data][packages][][quantity] |
integer |
Parcel quantity |
order[delivery][data][packages][][number] |
string |
Parcel barcode |
generic
Parameter | Type | Description |
---|---|---|
order[delivery][data][externalId] |
string |
Delivery id in delivery service |
order[delivery][data][trackNumber] |
string |
Track number (deprecated for write) |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][days] |
string |
Approximate delivery time |
order[delivery][data][statusText] |
string |
Delivery status name |
order[delivery][data][tariff] |
string |
Tariff code |
order[delivery][data][tariffName] |
string |
Tariff name |
order[delivery][data][pickuppointId] |
string |
Pickup point ID |
order[delivery][data][payerType] |
string |
Payer (sender , receiver ) |
order[delivery][data][cost] |
float |
Delivery cost received from delivery service |
order[delivery][data][extraData][] |
array |
Additional delivery data (deliveryDataField.code => value ) |
order[delivery][data][packages][] |
array of objects (Package) |
Packages |
order[delivery][data][packages][][packageId] |
string |
Package number |
order[delivery][data][packages][][weight] |
double |
Weight |
order[delivery][data][packages][][length] |
integer |
Length |
order[delivery][data][packages][][width] |
integer |
Width |
order[delivery][data][packages][][height] |
integer |
Height |
order[delivery][data][packages][][items][] |
array of objects (PackageItem) |
Package content |
order[delivery][data][packages][][items][][orderProduct] |
object (PackageItemOrderProduct) |
Order item |
order[delivery][data][packages][][items][][orderProduct][id] |
integer |
ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalId] |
string |
deprecated External ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][] |
array of objects (CodeValueModel) |
External IDs of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][][code] |
string |
Code |
order[delivery][data][packages][][items][][orderProduct][externalIds][][value] |
string |
Value |
order[delivery][data][packages][][items][][quantity] |
double |
Quantity |
Parameter | Type | Description |
---|---|---|
order[delivery][data][externalId] |
string |
Delivery id in delivery service |
order[delivery][data][trackNumber] |
string |
Track number (deprecated for write) |
order[delivery][data][tariff] |
string |
Tariff code |
order[delivery][data][pickuppointId] |
string |
Pickup point ID |
order[delivery][data][extraData][] |
array |
Additional delivery data (deliveryDataField.code => value ) |
order[delivery][data][packages][] |
array of objects (Package) |
Packages |
order[delivery][data][packages][][packageId] |
string |
Package number |
order[delivery][data][packages][][weight] |
double |
Weight |
order[delivery][data][packages][][length] |
integer |
Length |
order[delivery][data][packages][][width] |
integer |
Width |
order[delivery][data][packages][][height] |
integer |
Height |
order[delivery][data][packages][][items][] |
array of objects (PackageItem) |
Package content |
order[delivery][data][packages][][items][][orderProduct] |
object (PackageItemOrderProduct) |
Order item |
order[delivery][data][packages][][items][][orderProduct][id] |
integer |
ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalId] |
string |
deprecated External ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][] |
array of objects (CodeValueModel) |
External IDs of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][][code] |
string |
Code |
order[delivery][data][packages][][items][][orderProduct][externalIds][][value] |
string |
Value |
order[delivery][data][packages][][items][][quantity] |
double |
Quantity |
kazpost
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][statusText] |
string |
Delivery status name |
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
newpost
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][externalId] |
string |
deprecated Track number (Use trackNumber instead) |
order[delivery][data][statusCode] |
string |
deprecated Delivery status code |
order[delivery][data][statusDate] |
DateTime |
Date of the last delivery status updating |
order[delivery][data][days] |
string |
Approximate delivery time |
order[delivery][data][pickuppoint] |
string |
Pickup point |
order[delivery][data][pickuppointId] |
string |
Pickup point id |
order[delivery][data][statusName] |
string |
Delivery status name |
order[delivery][data][price] |
float |
Delivery cost received from delivery service |
order[delivery][data][shipmentpointId] |
string |
Shipment point id |
order[delivery][data][cargoDescription] |
string |
Cargo description |
order[delivery][data][payerType] |
string |
Payer type |
order[delivery][data][cashPayerType] |
string |
Payer type for cash on delivery |
order[delivery][data][paymentForm] |
string |
Payment form (field PaymentMethod in NewPost API) |
order[delivery][data][packageNumber] |
string |
Package number |
order[delivery][data][notes] |
string |
Additional information on sending |
order[delivery][data][preferredDeliveryDate] |
DateTime |
Preferred delivery date |
order[delivery][data][timeInterval] |
string |
Time intervals delivery |
order[delivery][data][saturdayDelivery] |
boolean |
Saturday delivery |
order[delivery][data][deliveryDate] |
string |
Date when the recipient took the order |
order[delivery][data][denieReason] |
string |
Rejection reason |
order[delivery][data][afterpaymentOnGoodsCost] |
float |
Payment control |
order[delivery][data][declaredValue] |
float |
Declared value |
order[delivery][data][sendDate] |
DateTime |
Date of sending |
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][serviceType] |
string |
Delivery technology (field ServiceType in NewPost API) |
order[delivery][data][pickuppointId] |
string |
Pickup point id |
order[delivery][data][shipmentpointId] |
string |
Shipment point id |
order[delivery][data][receiverCity] |
string |
Delivery city name (city ID must be specified) |
order[delivery][data][receiverCityRef] |
string |
Delivery city ID in NewPost (city name must be specified) |
order[delivery][data][receiverStreet] |
string |
Delivery street name (street ID must be specified) |
order[delivery][data][receiverStreetRef] |
string |
Delivery street ID in NewPost (street name must be specified) |
order[delivery][data][seatsAmount] |
integer |
Quantity of sending seats |
order[delivery][data][paymentForm] |
string |
Payment form (field PaymentMethod in NewPost API) |
order[delivery][data][declaredValue] |
float |
Declared value |
order[delivery][data][sendDate] |
DateTime |
Date of sending |
russianpost
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][statusCode] |
string |
deprecated Delivery status code |
order[delivery][data][statusDate] |
DateTime |
Date of the last delivery status updating |
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
sdek
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][externalId] |
string |
deprecated Track number |
order[delivery][data][statusCode] |
string |
deprecated Delivery status code |
order[delivery][data][statusDate] |
DateTime |
Date of the last delivery status updating |
order[delivery][data][pickuppointId] |
string |
Pickup point id (field PvzCode in Sdek API) |
order[delivery][data][deliveryName] |
string |
Tariff name |
order[delivery][data][days] |
string |
Approximate delivery time |
order[delivery][data][payerType] |
string |
Payer (sender , receiver ) |
order[delivery][data][price] |
float |
Delivery cost received from delivery service |
order[delivery][data][insurancePrice] |
float |
Insurance cost |
order[delivery][data][receiverCity] |
string |
Delivery city ID in Sdek |
order[delivery][data][packageNumber] |
string |
Package number |
order[delivery][data][packages][] |
array of objects (SdekPackage) |
Packages |
order[delivery][data][packages][][packageId] |
string |
Package number |
order[delivery][data][packages][][weight] |
double |
Weight |
order[delivery][data][packages][][length] |
integer |
Length |
order[delivery][data][packages][][width] |
integer |
Width |
order[delivery][data][packages][][height] |
integer |
Height |
order[delivery][data][packages][][items][] |
array of objects (PackageItem) |
Package content |
order[delivery][data][packages][][items][][orderProduct] |
object (PackageItemOrderProduct) |
Order item |
order[delivery][data][packages][][items][][orderProduct][id] |
integer |
ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalId] |
string |
deprecated External ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][] |
array of objects (CodeValueModel) |
External IDs of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][][code] |
string |
Code |
order[delivery][data][packages][][items][][orderProduct][externalIds][][value] |
string |
Value |
order[delivery][data][packages][][items][][quantity] |
double |
Quantity |
order[delivery][data][packages][][number] |
string |
Number of the package |
order[delivery][data][packages][][barCode] |
string |
Bar code of package |
Parameter | Type | Description |
---|---|---|
order[delivery][data][trackNumber] |
string |
Track number |
order[delivery][data][pickuppointId] |
string |
Pickup point id (field PvzCode in Sdek API) |
order[delivery][data][tariffType] |
string |
Delivery method ID (field TariffTypeCode in Sdek API) |
order[delivery][data][receiverCity] |
string |
Delivery city ID in Sdek |
order[delivery][data][comment] |
string |
Comment to the order |
order[delivery][data][packages][] |
array of objects (SdekPackage) |
Packages |
order[delivery][data][packages][][packageId] |
string |
Package number |
order[delivery][data][packages][][weight] |
double |
Weight |
order[delivery][data][packages][][length] |
integer |
Length |
order[delivery][data][packages][][width] |
integer |
Width |
order[delivery][data][packages][][height] |
integer |
Height |
order[delivery][data][packages][][items][] |
array of objects (PackageItem) |
Package content |
order[delivery][data][packages][][items][][orderProduct] |
object (PackageItemOrderProduct) |
Order item |
order[delivery][data][packages][][items][][orderProduct][id] |
integer |
ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalId] |
string |
deprecated External ID of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][] |
array of objects (CodeValueModel) |
External IDs of order item |
order[delivery][data][packages][][items][][orderProduct][externalIds][][code] |
string |
Code |
order[delivery][data][packages][][items][][orderProduct][externalIds][][value] |
string |
Value |
order[delivery][data][packages][][items][][quantity] |
double |
Quantity |
order[delivery][data][packages][][number] |
string |
Number of the package |
order[delivery][data][packages][][barCode] |
string |
Bar code of package |
yandex
Parameter | Type | Description |
---|---|---|
order[delivery][data][externalId] |
string |
Track number in Yandex delivery |
order[delivery][data][trackNumber] |
string |
Track number in delivery service |
order[delivery][data][status] |
string |
Delivery status code |
order[delivery][data][pickuppointAddress] |
string |
Pickup point address |
order[delivery][data][service] |
string |
Delivery service name |
order[delivery][data][pickuppointId] |
string |
Pickup point id (field delivery_pickuppoint in Yandex.Delivery API) |
order[delivery][data][days] |
string |
Approximate delivery time |
Parameter | Type | Description |
---|---|---|
order[delivery][data][pickuppointId] |
string |
Pickup point id (field delivery_pickuppoint in Yandex.Delivery API) |