API v2 changelog

​

Affected endpoints:

• POST /parcels

​

Changed endpoints:

• GET /insights/parcels/series: Endpoint is now publicly visible (removed x-excluded flag)
• GET /insights/products/series: Endpoint is now publicly visible (removed x-excluded flag)
• GET /insights/parcels/buckets: Endpoint is now publicly visible (removed x-excluded flag)
• GET /insights/products/buckets: Endpoint is now publicly visible (removed x-excluded flag)
• GET /insights/parcels/counts-summary: Endpoint is now publicly visible (removed x-excluded flag)
• GET /analytics/shipping-methods: Endpoint is now publicly visible (removed x-excluded flag)
• GET /analytics/carriers: Endpoint is now publicly visible (removed x-excluded flag)

​

Changed endpoints:

• POST /shipping-price/multiple: Endpoint is now publicly visible (removed x-excluded flag)

​

Changed endpoints:

• GET /brand/{brand_domain}/return-portal/customs-declaration/download: Endpoint is now publicly visible (removed x-excluded flag)

​

Changed endpoints:

• POST /service-points/check_and_store: Endpoint is now publicly visible (removed x-excluded flag)
• POST /service-points/items_fit_in_shipment: Endpoint is now publicly visible (removed x-excluded flag)
• GET /service-points/{shop_type}/store: Endpoint is now publicly visible (removed x-excluded flag)
  • Parameter order_id: Example value changed from integer 123456789 to string '123456789'
  • Parameter service_point: Example value changed from integer 1 to string '1'
  • Parameter to_post_number: Example value changed from integer 1338 to string '1338'

​

Changed endpoints:

• Changes to OriginDetail schema:
  • Field company_close_time: Example value updated to include timezone (17:00:00Z)

​

Changed endpoints:

• Changes to ParcelsReport schema:
  • Field expires_at: Example value updated to include timezone (2022-07-14T08:38:10.226217Z)
  • Field updated_at: Example value updated to include timezone (2022-07-14T08:23:10.226265Z)
  • Field created_at: Example value updated to include timezone (2022-07-14T08:23:10.226265Z)

​

Changed endpoints:

• GET /users/me:
  • Field registered: Example value updated to ISO 8601 format with timezone (2022-04-06T11:29:37Z)

​

Changed endpoints:

• Changes to IntegrationWebhookBase schema:
  • Field integration.failing_since: Example value updated to include timezone (2019-02-03T06:48:07Z)
  • Field integration.last_fetch: Example value updated to include timezone (2019-02-03T06:48:07Z)
  • Field integration.last_updated_at: Example value updated to include timezone (2019-02-03T06:48:07Z)

​

Changed endpoints:

• Changes for POST /api/v2/webhooks/parcel-status-changed:
  • Request schema ParcelStatusChangedWebhook changed:
    • Field action added to IntegrationWebhookBase
• Changes for POST /api/v2/webhooks/return-created:
  • Request schema ReturnCreatedWebhook changed:
    • Field action added to IntegrationWebhookBase

​

Changed endpoints:

• Changes for POST /oauth2/token:
  • Request body application/x-www-form-urlencoded schema changed:
    • Field grant_type moved from property-level required to schema-level required

​

Changed endpoints:

• Changes for GET /service-points:
  • Parameter carrier description updated to clarify carrier filtering and validation requirements
  • Parameter address description updated with geocoding details and guidance on parameter combinations
  • Parameter city description updated to emphasize exact matching requirement
  • Parameter postal_code description updated to clarify exact matching behavior
  • Parameter house_number description updated to emphasize exact matching requirement
  • Parameter radius description updated for clarity
  • Parameter weight description updated to specify Poste Italiane weight limit behavior
  • Parameter pudo_id description updated to clarify DPD-specific usage
  • Parameter shop_type description updated to distinguish from general_shop_type
  • Parameter general_shop_type description updated to clarify normalized filtering
  • Response 200 example RetrieveServicePoints renamed to FullResponse with updated example data
  • Response 200 added new example MinimalResponse showing minimal service point data
  • Endpoint description updated with new “How carriers are selected” section
• Changes for GET /service-points/{service_point_id}:
  • Response 200 example updated with new example data
  • Field distance removed from single service point response example
• Changes for GET /carriers:
  • Response 200 schema description added
  • Response 200 items schema description added
  • Response 200 example updated with additional carrier codes
  • Response 404 removed
• Changes for service-point schema:
  • Field id description added
  • Field code description added
  • Field shop_type description added
  • Field extra_data description updated to clarify carrier-specific nature and lack of fixed structure
  • Field name description added
  • Field street description added
  • Field house_number description added
  • Field postal_code description added
  • Field city description added
  • Field latitude description added
  • Field longitude description added
  • Field email description added
  • Field phone description added
  • Field homepage description added
  • Field carrier description added
  • Field country description added
  • Field formatted_opening_times description updated with detailed explanation of dynamic computation and exception handling
  • Field distance description updated to clarify conditional return behavior
  • Field distance removed from required fields list
  • Schema example updated with new example data
• Changes for 400 error response:
  • Response schema properties descriptions added to code, request, and message fields
  • Response examples added: RequiredFieldMissing, AddressGeocodeFailure, CarrierNotEnabled, RadiusWithBoundingBox

​

Changed endpoints:

• Changes for POST /delivery-options:
  • Response 200 / application/json changed:
    • Field lead_time_hours added to service point delivery options
    • Field sustainability_rating added to service point delivery options
    • Field is_order_overweight added to service point delivery options
    • Field allowed_weight added to service point delivery options
  • Schema DeliveryOption description updated:
    • Reference link updated from /api/v2/create-a-parcel-or-parcels to /api/v2/parcels/create-a-parcel-or-parcels

​

Changed endpoints:

• Changes for POST /box/finalize:
  • Summary changed from “Finalizing a box” to “Finalize a Deutsche Post order”
  • Description updated to clarify the endpoint closes the current open box and generates an AWB document
  • Documentation (x-mint.content) updated with clearer workflow explanation and parameter details

​

Changed endpoints:

• Changes for GET /api/v2/user/invoices/{id}:
  • Description updated for clarity on retrieving detailed invoice information
• Changes for Invoice schema:
  • Field type enum values updated:
    • periodical changed to periodic
    • initial changed to initial_payment
    • other removed and re-ordered to end of enum
    • credit_limit added
  • Field type description updated with new invoice type definitions
  • Field price_incl example changed from 5.5 to 6.5
  • Field price_excl example changed from 6.5 to 5.5
  • Field date description changed from “The creation date of the invoice” to “The creation datetime of the invoice”
  • Field items description changed from “Link to the invoice” to “Link to retrieve invoice items of this invoice”
• Changes for InvoiceDetail schema:
  • Field type description and enum values incomplete (schema appears truncated in specification)

​

Changed endpoints:

• Changes for POST /box/finalize:
  • Description updated: Documentation references changed from “Sendcloud platform” to “Sendcloud panel”
• Changes for GET /checkout/configurations/{configuration_id}/delivery-options:
  • Description updated: Documentation references changed from “Sendcloud platform” to “Sendcloud panel”
  • Schema documentation updated: References to “Sendcloud platform” changed to “Sendcloud panel” in delivery options, shipping rates, and delivery dates descriptions
• Changes for POST /shipments:
  • Description updated: Documentation references changed from “Sendcloud platform” to “Sendcloud panel”; carrier count updated from “160+” to “80+”
• Changes for GET /parcels/statuses:
  • Description updated: Documentation references changed from “Sendcloud platform” to “Sendcloud panel”
• Changes for POST /parcels/{id}/cancel:
  • Description updated: Documentation references changed from “Sendcloud platform” to “Sendcloud panel”
• Changes for GET /carriers:
  • Description updated: Documentation references changed from “Sendcloud platform” to “Sendcloud panel”
• Changes for GET /shipping-price:
  • Parameter contract description updated: Reference changed from “Sendcloud platform” to “panel”
  • Request body parameter contract description updated: Reference changed from “Sendcloud platform” to “panel”
• Changes for webhooks configuration:
  • Documentation updated: References changed from “Sendcloud platform” to “Sendcloud panel”

​

Changed endpoints:

• Changes for ServicePoint Object schema:
  • Field is_active description updated to clarify it indicates data freshness from recent scraping, not operational availability
  • Field open_tomorrow description added to clarify it reflects operational availability based on operating schedule
  • Field open_upcoming_week description added to clarify it reflects operational availability over the next 7 days

​

Changed endpoints:

• Changes for GET /carriers:
  • Documentation link added for improved API reference navigation

​

Changed endpoints:

• Changes for POST /parcels and related parcel endpoints:
  • Request body schema ParcelItem changed:
    • Field dds_reference added
    • Field taric_doc_code added

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/shipping_methods:
  • Parameters changed:
    • Query param cursor added
    • Query param limit added

​

Changed endpoints:

• Changes for GET /api/v2/brand/{brand_domain}/return-portal/outgoing:
  • Response 200 / application/json changed:
    • Field data.labelless_service_point.general_shop_type now can be null
    • Field data.service_point.general_shop_type now can be null
• Changes for GET /api/v2/service-points/{service_point_id}:
  • Response 200 / application/json changed:
    • Field general_shop_type now can be null
• Changes for GET /api/v2/service-points:
  • Response 200 / application/json changed:
    • Field items.general_shop_type now can be null

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for PUT /api/v2/parcels:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • oneOf.2.parcels.allOf changed supported schemas
      • oneOf.1.parcel.allOf changed supported schemas
      • oneOf.0.failed_parcels.items.parcel.allOf changed supported schemas
• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • incoming_parcel_data.allOf changed supported schemas
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • returns.items.incoming_parcel_data.allOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/service-points/{service_point_id}:
  • Response 200 / application/json changed:
    • Field general_shop_type added
• Changes for GET /api/v2/service-points:
  • Parameters changed:
    • Query param general_shop_type added
  • Response 200 / application/json changed:
    • Field items.general_shop_type added
• Changes for GET /api/v2/brand/{brand_domain}/return-portal/outgoing:
  • Response 200 / application/json changed:
    • Field data.labelless_service_point.general_shop_type added
    • Field data.service_point.general_shop_type added

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Response 200 / application/json changed:
    • Field delivery_options.items.is_order_overweight added
    • Field delivery_options.items.allowed_weight added

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Response 200 / application/json changed:
    • Supported values for delivery_options.items.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
• Changes for GET /api/v2/tracking/{tracking_number}:
  • Response 200 / application/json changed:
    • Supported values for statuses.items.carrier_code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
    • Supported values for carrier_code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Supported values for parcel.allOf.0.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
• Changes for PUT /api/v2/parcels:
  • Response 200 / application/json changed:
    • Supported values for parcel.items.allOf.0.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
• Changes for POST /api/v2/parcels:
  • Response 200 / application/json changed:
    • Supported values for oneOf.2.parcels.items.allOf.0.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
    • Supported values for oneOf.1.parcel.allOf.0.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
    • Supported values for oneOf.0.failed_parcels.items.parcel.allOf.0.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;
• Changes for GET /api/v2/parcels:
  • Response 200 / application/json changed:
    • Supported values for parcels.items.carrier.code changed: ['spring', 'dhl_parcel_iberia', 'inpost_gb', 'yodel', 'cirro', 'tnt_it', 'dhl_ecommerce', 'hermes_at', 'amazon', 'hermes_de', 'plx', 'transforce', 'gls_nl', 'nacex', 'gls_es', 'skymail', 'evri_international', 'rjpv2', 'gls_eu', 'inpost_es', 'fietskoeriers', 'geodis', 'postnl_large', 'poste_it_delivery', 'mhi', 'storeshippers', 'bol', 'hurby', 'fedexcrossborder', 'dpd_local', 'dbschenker', 'postnord', 'dhl_parcel_gb', 'hived', 'inpost_pl', 'paack', 'dpd_fr', 'inpost_it', 'parcelforce', 'fedex', 'glovo', 'hermes_c2c_gb', 'dhl_2_man_handling', 'tipsa', 'ctt_express'] added;

​

Removed endpoints:

• POST /api/v2/brand/{brand_domain}/return-portal/rule-modifications

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Response 200 / application/json changed:
    • Field is_delivery_zone_configured added
    • Field is_delivery_zone_excluded added

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Field parcel.allOf.0.note added
• Changes for PUT /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field parcel.items.allOf.0.note added
• Changes for POST /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field oneOf.2.parcels.items.allOf.0.note added
    • Field oneOf.1.parcel.allOf.0.note added
    • Field oneOf.0.failed_parcels.items.parcel.allOf.0.note added
• Changes for GET /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field parcels.items.note added

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for PUT /api/v2/parcels:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • oneOf.2.parcels.allOf changed supported schemas
      • oneOf.1.parcel.allOf changed supported schemas
      • oneOf.0.failed_parcels.items.parcel.allOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Response 200 / application/json changed:
    • Field delivery_options.items.lead_time_hours added
    • Field delivery_options.items.sustainability_rating added

​

Changed endpoints:

• Changes for GET /api/v2/parcels:
  • Parameters changed:
    • Query param external_reference added

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for PUT /api/v2/parcels:
  • Parameters changed:
    • Supported values for parcel.customs_information.tax_numbers.importer_of_record.items.name changed: ['UKIMS'] added;
    • Supported values for parcel.customs_information.tax_numbers.receiver.items.name changed: ['UKIMS'] added;
    • Supported values for parcel.customs_information.tax_numbers.sender.items.name changed: ['UKIMS'] added;
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • oneOf.2.parcels.allOf changed supported schemas
      • oneOf.1.parcel.allOf changed supported schemas
      • oneOf.0.failed_parcels.items.parcel.allOf changed supported schemas
• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • incoming_parcel_data.allOf changed supported schemas
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • returns.items.incoming_parcel_data.allOf changed supported schemas
• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameters changed:
    • Supported values for customs_information.tax_numbers.importer_of_record.items.name changed: ['UKIMS'] added;
    • Supported values for customs_information.tax_numbers.receiver.items.name changed: ['UKIMS'] added;
    • Supported values for customs_information.tax_numbers.sender.items.name changed: ['UKIMS'] added;

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object: root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for PUT /api/v2/parcels:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas
• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • oneOf.2.parcels.allOf changed supported schemas
      • oneOf.1.parcel.allOf changed supported schemas
      • oneOf.0.failed_parcels.items.parcel.allOf changed supported schemas
• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • incoming_parcel_data.allOf changed supported schemas
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • returns.items.incoming_parcel_data.allOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Parameters changed:
    • Query param checkout_metadata added

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/rule-modifications:
  • Parameters changed:
    • Request body param refund_type added
    • Request body param items.items.sku added
  • Response 200 / application/json changed:
    • Field modifications added
    • Field shipping_method_code removed
    • Field fee removed
    • Field disable_requests removed
    • Field not_returnable_items removed
    • Field parcel_not_returnable removed

​

Changed endpoints:

• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • incoming_parcel_data.allOf changed supported schemas, ['Return Parcel Object'] added
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • returns.items.incoming_parcel_data.allOf changed supported schemas, ['Return Parcel Object'] added
• Changes for POST /api/v2/brand/{brand_domain}/return-portal/uploads:
  • Now can return 401 / application/json response
• Changes for GET /api/v2/brand/{brand_domain}/return-portal/label/download:
  • Now can return 401 / application/json response
• Changes for GET /api/v2/brand/{brand_domain}/return-portal/label/polling:
  • Now can return 401 / application/json response
• Changes for POST /api/v2/brand/{brand_domain}/return-portal/rule-modifications:
  • Now can return 401 / application/json response
• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameters changed:
    • Request body param customs_information added
  • Now can return 401 / application/json response
• Changes for GET /api/v2/brand/{brand_domain}/return-portal/outgoing:
  • Now can return 401 / application/json response
• Changes for GET /api/v2/brand/{brand_domain}/return-portal:
  • Now can return 401 / application/json response

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Field parcel.allOf.0.reference added
    • Field parcel.allOf.0.external_reference now can be null
• Changes for PUT /api/v2/parcels:
  • Parameters changed:
    • Request body param parcel.reference added
    • Request body param parcel.external_reference now can be null
  • Response 200 / application/json changed:
    • Field parcel.items.allOf.0.reference added
    • Field parcel.items.allOf.0.external_reference now can be null
• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 200 / application/json changed:
    • Field oneOf.2.parcels.items.allOf.0.reference added
    • Field oneOf.1.parcel.allOf.0.reference added
    • Field oneOf.0.failed_parcels.items.parcel.allOf.0.reference added
    • Field oneOf.2.parcels.items.allOf.0.external_reference now can be null
    • Field oneOf.1.parcel.allOf.0.external_reference now can be null
    • Field oneOf.0.failed_parcels.items.parcel.allOf.0.external_reference now can be null
• Changes for GET /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field parcels.items.reference added
    • Field parcels.items.external_reference now can be null

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object: root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}/return_portal_url:
  • Now can return 401 response
• Changes for POST /api/v2/parcels/{id}/cancel:
  • Now can return 401 response
• Changes for GET /api/v2/parcels/{id}:
  • Now can return 401 response
• Changes for PUT /api/v2/parcels:
  • Now can return 401 response
• Changes for POST /api/v2/parcels:
  • Now can return 401 response
• Changes for GET /api/v2/parcels:
  • Now can return 401 response

​

Changed endpoints:

• Changes for POST /api/v2/box/finalize:
  • Now can return 401 response

​

Changed endpoints:

• Changes for POST /api/v2/integrations/{id}/shipments:
  • Parameters changed:
    • Request body param items.customs_details added
• Changes for GET /api/v2/integrations/{id}/shipments:
  • Response 200 / application/json changed:
    • Field results.items.customs_details added

​

Changed endpoints:

• Changes for GET /api/v2/brand/{brand_domain}/return-portal/label/download:
  • Now can return 404 / application/json response

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas, ['Parcel Object'] added
    • Field parcel.id removed
• Changes for PUT /api/v2/parcels:
  • Parameters changed:
    • Request body param parcel.customs_information added
    • Request body param parcel.parcel_items.items.mid_code added
    • Request body param parcel.parcel_items.items.material_content added
    • Request body param parcel.parcel_items.items.intended_use added
  • Response 200 / application/json changed:
    • Polymorphism object:
      • parcel.allOf changed supported schemas, ['Parcel Object'] added
• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • oneOf.2.parcels.allOf changed supported schemas, ['Parcel Object'] added
      • oneOf.1.parcel.allOf changed supported schemas, ['Parcel Object'] added
      • oneOf.0.failed_parcels.items.parcel.allOf changed supported schemas, ['Parcel Object'] added
    • Field oneOf.1.parcel.id removed
    • Field oneOf.0.failed_parcels.items.parcel.id removed
• Changes for GET /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field parcels.items.parcel_items.items.mid_code added
    • Field parcels.items.parcel_items.items.material_content added
    • Field parcels.items.parcel_items.items.intended_use added

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object: root.oneOf changed supported schemas

​

Added endpoints:

• POST /api/v2/brand/{brand_domain}/return-portal/rule-modifications

​

Changed endpoints:

• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Field rule_modifications added
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Field returns.items.rule_modifications added

​

Changed endpoints:

• GET /api/v2/customs_declaration/normal_printer entered deprecation phase.

​

Changed endpoints:

• Changes for GET /api/v2/parcels/{id}:
  • Response 200 / application/json changed:
    • Field parcel.colli_tracking_number removed
• Changes for PUT /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field parcel.items.colli_tracking_number removed
• Changes for POST /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field oneOf.2.parcels.items.colli_tracking_number removed
    • Field oneOf.1.parcel.colli_tracking_number removed
    • Field oneOf.0.failed_parcels.items.parcel.colli_tracking_number removed
• Changes for GET /api/v2/parcels:
  • Response 200 / application/json changed:
    • Field parcels.items.colli_tracking_number removed

​

Changed endpoints:

• Changes for GET /api/v2/brand/{brand_domain}/return-portal:
  • Response 200 / application/json changed:
    • Field portal.layout.helper_text added

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Response 200 / application/json changed:
    • Field delivery_options.items.internal_title added

​

Changed endpoints:

• Changes for POST /api/v2/pickups:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
  • Response 201 / application/json changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas
• Changes for GET /api/v2/pickups/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Parameters changed:
    • Query param to_postal_code added
    • Query param parcel_length added
    • Query param parcel_width added
    • Query param parcel_height added

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameters changed:
    • Request body param images.items.product_id added
    • Request body param images.items.productId removed
• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Field images.items.product_id added
    • Field images.items.productId removed
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Field returns.items.images.items.product_id added
    • Field returns.items.images.items.productId removed

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/uploads:
  • Response 201 / application/json changed:
    • Field items.name added
    • Field items.id removed

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/shipping-price:
  • Parameters changed:
    • Query param from_postal_code added
    • Query param to_postal_code added

​

Changed endpoints:

• Changes for GET /api/v2/tracking/{tracking_number}:
  • Response 200 / application/json changed:
    • Supported values for statuses.items.carrier_code changed: ['dpd_gb', 'gls_de', 'sendcloud', 'poste_italiane', 'postnl_fulfilment', 'viatim', 'bpost', 'lettresuivie', 'van_straaten', 'colissimo', 'dp', 'dhl', 'sandd', 'fairsenden', 'postat', 'royal_mail', 'fadello', 'dhl_de', 'dhl_express', 'colisprive', 'ups', 'seur', 'mondial_relay', 'gls_it', 'postnl', 'delivengo', 'budbee', 'correos_express', 'homerr', 'hermes_gb', 'chronopost', 'rjp', 'trunkrs', 'dpd', 'brt', 'dpd_at', 'mrw', 'correos'] added;
    • Supported values for carrier_code changed: ['dpd_gb', 'gls_de', 'sendcloud', 'poste_italiane', 'postnl_fulfilment', 'viatim', 'bpost', 'lettresuivie', 'van_straaten', 'colissimo', 'dp', 'dhl', 'sandd', 'fairsenden', 'postat', 'royal_mail', 'fadello', 'dhl_de', 'dhl_express', 'colisprive', 'ups', 'seur', 'mondial_relay', 'gls_it', 'postnl', 'delivengo', 'budbee', 'correos_express', 'homerr', 'hermes_gb', 'chronopost', 'rjp', 'trunkrs', 'dpd', 'brt', 'dpd_at', 'mrw', 'correos'] added;
• Changes for GET /api/v2/brands/{id}:
  • Response 200 / application/json changed:
    • Field customization_settings.footer.whatsapp_business added
• Changes for GET /api/v2/brands:
  • Response 200 / application/json changed:
    • Field brands.items.customization_settings.footer.whatsapp_business added
• Changes for GET /api/v2/brand/{brand_domain}/return-portal:
  • Response 200 / application/json changed:
    • Field portal.brand.customization_settings.footer.whatsapp_business added

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameters changed:
    • Request body param products.items.return_message is not nullable anymore
    • Request body param products.items.return_reason is not nullable anymore
    • Request body param products.items.product_id is not nullable anymore
    • Request body param products.items.origin_country is not nullable anymore
    • Request body param products.items.origin_country has new maximum length restriction: 2
    • Request body param products.items.origin_country has new format: iso-2
• Changes for GET /api/v2/brand/{brand_domain}/return-portal/outgoing:
  • Response 200 / application/json changed:
    • Field data.shipping_products.items.methods.items.pickup_date now can be null
    • Field data.shipping_products.items.methods.items.pickup_date is not nullable anymore
    • Field data.parcel.collo_count now can be null
    • Field data.parcel.collo_count is not nullable anymore
    • Field data.parcel.to_state now can be null
    • Field data.parcel.to_state is not nullable anymore
    • Field data.parcel.id now can be null
    • Field data.parcel.id is not nullable anymore
  • Response 422 / application/json changed:
    • Field error.message changed its type to string
• Changes for GET /api/v2/brand/{brand_domain}/return-portal:
  • Response 200 / application/json changed:
    • Field return_locations.items.country_state now can be null
    • Field return_locations.items.country_state is not nullable anymore
    • Field portal.layout.background_image now can be null
    • Field portal.layout.background_image is not nullable anymore

​

Added endpoints:

• POST /api/v2/brand/{brand_domain}/return-portal/uploads

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameters changed:
    • Request body param images added
• Changes for GET /api/v2/returns/{id}:
  • Response 200 / application/json changed:
    • Field images added
• Changes for GET /api/v2/returns:
  • Response 200 / application/json changed:
    • Field returns.items.images added

​

Changed endpoints:

• Changes for POST /api/v2/parcels:
  • Parameters changed:
    • Polymorphism object:
      • root.oneOf changed supported schemas

​

Changed endpoints:

• Changes for GET /api/v2/contracts/{id}:
  • Response 200 / application/json changed:
    • Field is_default added
• Changes for GET /api/v2/contracts:
  • Response 200 / application/json changed:
    • Field contracts.items.is_default added

​

Changed endpoints:

• Changes for GET /api/v2/integrations/{id}:
  • Response 200 / application/json changed:
    • Field webhook_url now can be null
    • Field shop_url now can be null
• Changes for GET /api/v2/integrations:
  • Response 200 / application/json changed:
    • Field items.webhook_url now can be null
    • Field items.shop_url now can be null

​

Changed endpoints:

• Changes for GET /api/v2/brand/{brand_domain}/return-portal/outgoing:
  • Response 200 / application/json changed:
    • Field data.applicable_actions.items.priority added

​

Changed endpoints:

• Changes for GET /api/v2/brand/{brand_domain}/return-portal:
  • Response 200 / application/json changed:
    • Field portal.layout added

​

Changed endpoints:

• Changes for POST /api/v2/integrations/{id}/logs:
  • Parameters changed:
    • Request body param exception now can be null
    • Request body param base_url is not nullable anymore
    • Request body param base_url has new minimal length restriction: 1
    • Request body param method is not nullable anymore
  • Response 201 / application/json changed:
    • Field exception now can be null
    • Field base_url is not nullable anymore
    • Field base_url has new minimal length restriction: 1
    • Field method is not nullable anymore
• Changes for GET /api/v2/integrations/{id}/logs:
  • Response 200 / application/json changed:
    • Field results.items.base_url is not nullable anymore
    • Field results.items.base_url has new minimal length restriction: 1
    • Field results.items.method is not nullable anymore
• Changes for GET /api/v2/integrations/logs:
  • Response 200 / application/json changed:
    • Field results.items.base_url is not nullable anymore
    • Field results.items.base_url has new minimal length restriction: 1
    • Field results.items.method is not nullable anymore

​

Changed endpoints:

• Changes for GET /api/v2/integrations/{id}/shipments:
  • Parameters changed:
    • Query param ordering removed

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameters changed:
    • Request body param service_point.code removed
    • Request body param service_point.is_active removed
    • Request body param service_point.extra_data removed
    • Request body param service_point.name removed
    • Request body param service_point.street removed
    • Request body param service_point.house_number removed
    • Request body param service_point.postal_code removed
    • Request body param service_point.city removed
    • Request body param service_point.latitude removed
    • Request body param service_point.longitude removed
    • Request body param service_point.email removed
    • Request body param service_point.phone removed
    • Request body param service_point.homepage removed
    • Request body param service_point.carrier removed
    • Request body param service_point.country removed
    • Request body param service_point.formatted_opening_times removed
    • Request body param service_point.open_tomorrow removed
    • Request body param service_point.open_upcoming_week removed
    • Request body param service_point.distance removed
    • Request body param service_point.shop_type removed
    • Request body param service_point.id has new format: int64

​

Changed endpoints:

• Changes for GET /api/v2/shipping-products:
  • Parameter changes:
    • Parameter returns added

​

Changed endpoints:

• Changes for GET /api/v2/shipping_methods/{id}:
  • Response 200 / application/json changed:
    • Field shipping_method.countries.items.price_breakdown added
• Changes for GET /api/v2/shipping_methods:
  • Response 200 / application/json changed:
    • Field shipping_methods.items.countries.items.price_breakdown added
• Changes for GET /api/v2/shipping-price:
  • Response 200 / application/json changed:
    • Field items.breakdown added

​

Changed endpoints:

• Changes for POST /api/v2/brand/{brand_domain}/return-portal/incoming:
  • Parameter changes:
    • Parameter incoming_parcel.from_country_state added

​

Changed endpoints:

• Changes for GET /api/v2/brand/{brand_domain}/return-portal/outgoing:
  • Response 200 / application/json changed:
    • Field data.products.items.image_url added
    • Field examples.OutgoingParcel.value.data.products.0.image_url added

​

Changed endpoints:

• Changes for GET /pickups:
  • Response 200 / application/json changed:
    • Field examples.RetrieveDHLParcelIberiaPickups added
• Changes for POST /pickups:
  • Parameter changes:
    • Parameter examples.DHLParcelIberiaPickupRequest added
  • Response 201 / application/json changed:
    • Field examples.SuccessfullyCreatedDHLParcelIberiaPickup added
• Changes for GET /pickups/{id}:
  • Response 200 / application/json changed:
    • Field examples.RetrieveDHLParcelIberiaPickup added

​

Changed endpoints:

• Changes for GET /api/v2/checkout/configurations/{configuration_id}/delivery-options:
  • Response 200 / application/json changed:
    • Field removed: delivery_options.items.delivery_dates.items.delivery_date
    • Field removed: delivery_options.items.delivery_dates.items.parcel_handover_date
    • Field delivery_options.items.delivery_dates is now required
    • Field delivery_options.items.delivery_dates can be null now

​

Changed endpoints:

• Changes for GET /api/v2/integrations/{id}/shipments:
  • Parameter changes:
    • Added new parameter: end_date
    • Added new parameter: external_order_ids
    • Added new parameter: external_shipment_ids
    • Added new parameter: order_number
    • Added new parameter: sender_address
    • Added new parameter: shipping_rules
    • Added new parameter: start_date