Changelog
This page records changes made to the API documentation.
Label webhook payload and size event documentation updated
Changed
Documented package, replacedLabel, trackingType and label timestamps; added package and barcode replacement examples; aligned status and size example timestamps with RFC 3339
Changed
Explained the PTT size.updated trigger for weight/desi totals
EU product identifier (EU PID) fields added to international consignment creation
Added
The `packages.items.merchant_product_id`, `packages.items.manufacturer_product_id` and `packages.items.standard_product_id` fields were added to the international consignment creation documentation
Added
Added that PID data is mandatory for B2C shipments to EU countries from November 1, 2026, and that shipments with missing PIDs may be held at customs
Changed
International consignment example payloads, full language examples and common error scenarios were updated with the PID fields
PTT Contract consignment documentation added
Added
Contract consignment creation page added
Added
Documented sending contract ID and contract name with the `CONTRACT` package type
Added
Documented pre-shipment contract document approval and the `consignee.tax_number` requirement
Cancel consignment documentation aligned with the current service scope
Removed
The `DELETE` method section was removed from the cancel consignment page. Consignment deletion is not part of the current ComToHome API service scope; cancellation is handled through the `cancel` endpoint
Consignment status descriptions updated
Changed
Consignment status descriptions updated.
Dummy event generation header documented for single package consignment creation
Added
New `X-Create-Dummy-Data` header documented for domestic and international single package consignment creation. Staging environment only — generates randomly selected dummy events for the created consignment to support tracking flow testing
New party type fields added to international consignment creation
Added
New `consignor.party_type` field added to international consignment creation
Added
New `consignee.party_type` field added to international consignment creation
IOSS number request payload support documented
Changed
The `ioss_number` field was added as a root-level request parameter in the international consignment creation documentation
Changed
Previous customer-parameter and automatic-assignment wording for IOSS was removed
Changed
International consignment example payloads and full language examples were updated with the `ioss_number` field
Courier pickup request documentation added
Added
Request schema, validation rules, success/error responses, and example scenarios documented
Webhook examples, package type and barcode field updates
Added
Webhook payload examples added (consignment.status.updated, consignment.label.created, consignment.size.updated)
Added
Proforma Invoice automatic document generation support added for international consignments (generate_templated_documents)
Changed
Account representative guidance added to specific_provider_barcode description
Initial API documentation release
Added
Consignment API (Domestic, International, Multi-Package consignment creation)
Added
Webhook API (Create, List, Delete)
Added
Address API (Province, District, Neighborhood queries)
Added
GTIP API (GTIP code queries)
Added
Logistic Provider API (Provider listing and features)