Labels
createLabel
createLabel allows you to create a label in PDF or ZPL format (Settings should be configured on the control panel).POSThttps://api.qapla.it/1.4/createLabel/
Test
It is possible to obtain a test "dummy label" using the courier with GENERIC code.Request
Parameters
*Mandatory Parameters
| Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apiKey*(string) | The channel's API Key | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sandbox(boolean) | It is true if using the sandbox (test mode) Attention: this parameter works if the courier has already been set correctly on the channel. Contact Qaplà's Customer Care. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| includeExtShipmentID(boolean) | If true, it adds the additional shipment ID provided by the courier to the response body (e.g. DHL Express booking code). Default: false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| costCenterCode(string) | Allows you to optionally specify a code relating to a specific cost center that will be used when generating labels for the order in question. This parameter is only active for the PTI courier. Attention: if no code is specified, or if the specified code is not among those configured for the channel, the cost center configured as default will automatically be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| origin(string) | Shipment origin, permitted values:
ahlens, aliexpress, allegro, alltricks, amazon, animalis, anthropologie, asos, atlasformen, auchan, bandq, beerwulf, bestsecret,
bhv, bigcommerce, bild, blackredwhite, blokker, boots, brandalley, bricobravo, bricodepot, bricomarche, bricoprive, bulevip, but, carrefour_es,
carrefour_fr, casadellibro, castorama, cdiscount, commercelayer, conforama, creavea, cultura, darty, debenhams, decathlon, douglas, ebay, ecwid,
elcorteingles, elkjop, ellos, empik, eprice, etsy, fanatics, feelunique, fnac, fonq, freepeople, fressnapf, gifi, greenweez_fr, handm, home24, ibs,
incomedia, lafayette, laredoute, leroyMerlin_it, magento, magento2, maisonDuMonde_es, maisonDuMonde_it, manomano, manomano_de, manomano_es, manomano_fr,
manomano_gb, manomano_it, matalan, mathon, maty, maykers, mediaMarkt_at, mediaMarkt_de, mediaMarkt_es, mediaMarkt_it, mediaMarkt_nl, miravia_es, modivo_pl,
mountainwh, natureetdeco, newcart, nocibe, obelink, pandacola, pccomponentes, perfumesclub, phonehouse, pixmania, placedestend, planetahuerto, pourdebon,
prestashop, printemps, privalia, privalia_es, privalia_it, privsportshop, public, quirumed, redcarepharmacy, rueducommerce, sarenza, shopapotheke, shopify,
shopware6, showroomprive, slood, spartoo, spartoo_be, spartoo_bg, spartoo_cn, spartoo_com, spartoo_comhr, spartoo_couk, spartoo_cz, spartoo_de, spartoo_dk,
spartoo_es, spartoo_fi, spartoo_fr, spartoo_gb, spartoo_gr, spartoo_hu, spartoo_it, spartoo_nl, spartoo_pl, spartoo_pt, spartoo_ro, spartoo_se, spartoo_si, spartoo_sk, sprinter_es,
stadium, storeden¤, superdrug, teamsystemcommerce¤tiendanimal, tradeinn, truffaut, twil, ubaldi, urbanoutfitters, venca, venteunique, vivino, vtex, watchfinder,
winesitting, woocommerce, wook, worten_es, worten_pt, yoox
¤storeden and teamsystemcommerce can be used as synonyms
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reference*(string) | Order's alphanumeric reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| orderID(string) | Possible order's numeric reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| courier*(string) | The Qapla' courier code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| courierService*(string) | Possible kind of courier service; for example it can be the contract code of GLS Italy. If the field is empty or not sent, the default is '0'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name*(string) | Recipient name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| address*(string) | Recipient address | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| city*(string) | Recipient city | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| state*(string) | Recipient province | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| postCode*(string) | Recipient Postal Code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| country*(string) | Recipient country in format ISO 3166-1 alpha-2 (I.E.: IT) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| email(string) | Recipient email | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| telephone(string) | Recipient telephone | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| amount(float) | Shipment amount. Specify only one separator (the dot) to indicate decimals, and do not use separators to indicate thousands. Give a maximum of two decimal digits. Example: 2340.23 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingCost(float) | Shipping Cost. Specify only one separator (the dot) to indicate decimals, and do not use separators to indicate thousands. Give a maximum of two decimal digits. Example: 9.35 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currencyCode(string) | Currency code ISO 4217 (default: EUR) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isCOD(boolean) | It is true if payment is cash on delivery | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| payment(string) | Possible order's payment method. Can be set to CONTRASSEGNO only if isCOD is also set to true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notes(string) | Any order note | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parcels(int|array) |
Possible parcels of the delivery. Each shipment can be defined through an object composed as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| weight(float) | Potential weight of the order (not available when "parcels" is an array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| length(float) | Potential measures: length (not available when "parcels" is an array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| width(float) | Potential measures: width (not available when "parcels" is an array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| height(float) | Potential measures: height (not available when "parcels" is an array) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingCODPaymentOption(string) | Payment method of cash on delivery if different from default settings (to be agreed) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingInsurance(float | string) |
Potential insured amount ALL-IN: insert into "shippingDeliveryOptions" the following string: ALLIN To generate directly with SDA, the value must be passed in the form of a string, specifying one of the following codes:
To generate directly with CRONO PTI, the value must be passed in the form of a string, specifying one of the following codes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingDeliveryOptions(string | JSON) |
For PTI courier you need to use a JSON structured as follows
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingRequiredDeliveryDate(YYYY-MM-DD) | The delivery request date in the format YYYY-MM-DD (mandatory for PAACK courier) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingRequiredDeliveryTimeSlot(HS-HE) |
Expected delivery time window for the order in HS-HE string format (currently used only by PAACK courier). Indicates the expected delivery time window for the order: the start time (HS) and the end time (HE) must be between 0 and 23. Example of usage: "shippingRequiredDeliveryDate": "2026-01-20" "shippingRequiredDeliveryTimeSlot": "8-21" In this case, the expected delivery time window will be between 08:00:00 and 21:00:00 on 01/20/2026. When the field is left out, the default time slot configured on the channel for the PAACK courier is used: it is the same one the Control Panel offers already selected when a label is created by hand. A value sent with the request always takes precedence over the default. The field is therefore mandatory only when no default time slot is configured on the channel for PAACK, or when the courier configuration on the channel is incomplete: the call then answers |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| latestShipDate(string) | To be shipped by this date in the YYYY-MM-DD format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| latestDeliveryDate(string) | To be delivered by this date in the YYYY-MM-DD format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tag(string) | Colored tag, allowed values: green, yellow, orange, blue, cyan, red | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pickupDate(YYYY-MM-DD) | The collection date requested to the courier in format YYYY-MM-DD
For the SDA courier, if this field is not specified when creating the label, during the transmission of the label it will be automatically assigned the working day following that of transmission. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| printNodePrinterID(int | string) | Possible id or name of the printer to be used with PrintNode (to be agreed) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| forceReprint(int) | If set to 1, it forces the label to be printed again via PrintNode; valid when used with "printNodePrinterID" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| content(string) | The content of the goods that may be present on the label (depends on the courier) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| custom1(string) | A custom field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| custom2(string) | A custom field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| custom3(string) | A custom field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sender |
It is the sender of the shipment if different from the contract holder.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tradeDocuments |
Electronic documents to be sent to the courier. You can upload more than one file per shipment. The maximum size of each file is 5 MB. For the moment only available for DHL, FedEx and UPS couriers. Passed as an array of objects, with three mandatory elements each:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rows(array) |
It is an array of "order rows". It is not mandatory, but if populated it has some mandatory data. When mandatory data is not filled-in, row item can be ignored and not inserted. In order to update or remove all rows from an order use "forceRowsUpdate". Keep in mind that orders are modified only when there labels don't exist for the order.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| assemblyTypes(array) |
Possible list of assembly types, one per product, for couriers who support this information
Available for the "courierService" 20 (HD). One element must be specified for each element of rows. Available values for "code":
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PUDO(object) |
Allows you to set a Pick-up or Drop-off point for the collection of goods. Each field must be completed according to the courier's need. Refer to the tables below name, address, city, state, country e postalCode are required if you want to include the PUDO address in transactional emails
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| invoice(object) |
It allows you to set information regarding the invoice associated with the shipment, useful for shipments that have to go through customs.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dangerousGoods(JSON) |
For FEDEX courier you need to use a JSON structured as follows parcel: represents the number of the parcels that contains the dangerous goods (in the example a shipment with 3 parcels and only the first and the third contain dangerous goods)
type: battery
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| forceLabelsOutput(int) | If set to 1, the "createLabel" API will return the generated labels even when printed with PrintNode. Can only be used if "printNodePrinterID" is also set. Default value: 0 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| goodsCode(string) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| forceRowsUpdate(int) | If set to 1, the "createLabel" API will rewrite all items rows in the existing order when trying to update the order itself. Keep in mind that when there already are labels availbale for the order, the order will not be modified. If rows are empty, the order items will be deleted. Default value: 0 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| recipientTin(string) | Recipient's Tax Identification number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| recipientTinType(string) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingCharge(string) |
Indicates to whom the shipping costs will be charged. If different from SENDER, you must also specify shippingChargeAccount. Allowed values: SENDER,RECIPIENT,THIRD_PARTY. Available for FedEx courier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| shippingChargeAccount(string) |
Account to which the shipping costs will be charged. Available for FedEx courier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pickupType(string) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| signatureRequired | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customCharges(string) |
Indicates to whom the customs charges will be billed. If different from SENDER, you must also specify customChargesAccount. Allowed values: SENDER,RECIPIENT,THIRD_PARTY. Available for FedEx courier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customChargesAccount(string) |
Account to which the customs charges will be billed. Available for FedEx courier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customsChargesBroker(string) | Reference code of the Broker to whom customs clearance is entrusted. Attention: contact customer support to enter the broker's data and assign the code. Available for FedEx courier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customsRecipientIDType(string) | Type of recipient's identification document, useful for customs clearance. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| customsRecipientID(string) |
Identifier of the recipient's document, to be specified if customsRecipientIDType is specified Available for Fedex courier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| totalCustomsValue(float) | Total declared value for customs clearance. Available for FedEx courier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Body200
| Parameter | Description |
|---|---|
| isShipped(boolean) | It istrue if the order has alredy been labeled and returns the label alredy created. |
| id(int) | Shipment ID. Important to invoke other APIs. |
| courier(string) | The Qapla' courier code the label was created with: the same one sent in the request, or — when the courier was picked by the channel rules — the code of the courier the rules elected. |
| trackingNumber(string) | Shipment tracking number. |
| returnTrackingNumber(string) | If a returnn label is requested |
| format(string) | Label format:
|
| labels(array) | An array with the base64 of the labels obtained (there may be multiple labels for multiple packages or returns, etc.).
Or The ZPL for printing on Zebra, as configured on the Control Panel. |
| labelStatus(string) | The state of the label at the time of the response.
PENDING is not an error: "result" is "OK" and the shipment already exists. Do not call createLabel again — a second call may create and charge a second shipment. Read the label again with "getLabel" after a few minutes. |
| extShipmentID(string) | Optional additional ID provided by the courier. It is added to the body only if "includeExtShipmentID" is true in the request. |
| parcelsTracking(array|null) | Array of objects containing the tracking number for each individual parcel in the shipment. Present only when the courier returns distinct tracking numbers per parcel (e.g. GLS, BRT, UPS, SDA, DHL, FedEx). Each element has the structure: {"trackingNumber": "..."}. The field is null if the courier does not support per-parcel tracking. |