API v3 Changelog

​

Changed endpoints:

• Field announced_by added to the shipment object in the responses of these endpoints:
  • POST /shipments/announce
  • POST /shipments
  • POST /shipments/announce-with-shipping-rules
  • POST /shipments/create-with-shipping-rules
  • GET /shipments
  • GET /shipments/{id}
• announced_by contains the id and name of the user who started the announcement, or of the organization owner when no specific user started it. It’s always null in the 201 response of the asynchronous create endpoints because announcement happens afterwards.

​

Changed endpoints:

• Each endpoint page now lists the OAuth2 scopes it requires. See Scopes for OAuth apps for what each scope grants.
• The OAuth2ClientCreds security scheme now lists every available scope.

​

Changed endpoints:

• Field announced_at in the response can now be null. It is null until Sendcloud has an announcement date for the parcel. The field is always present.
• Field weight in parcel_items in the response can now be null. It is null when the stored weight is 0 or less.
• These changes apply to:
  • POST /parcels/tracking
  • GET /parcels/tracking/{tracking_number}

​

Changed endpoints:

• Field carrier.last_mile added to the shipment object in the responses of these endpoints:
  • POST /shipments/announce
  • POST /shipments
  • POST /shipments/announce-with-shipping-rules
  • POST /shipments/create-with-shipping-rules
  • GET /shipments
  • GET /shipments/{id}
• carrier.last_mile is the code of the carrier that makes the final delivery, when the carrier reports one. It’s null for most carriers, and always null in the 201 response of the asynchronous create endpoints because announcement happens afterwards.

​

Added endpoints:

• POST /dsf/tickets/other

​

Changed endpoints:

• Changes for POST /dsf/tickets/other:
  • Accepts requests for both Sendcloud rates parcels and own contract parcels
  • Request field subject added (required, 5–100 characters)
  • Request field question added (required, minimum 10 characters)

​

Changed endpoints:

• Changes for POST parcels.event.created (webhook):
  • The data.event field now delivers two distinct payload shapes based on data.event.event_type:
    • carrier / calculated → Tracking Event (existing shape: phase, exception, status_type, sub_status, location details, etc.)
    • claim → Claim Event (new shape for Support Automation ticket updates)
  • New Claim Event shape added (event_type: "claim") with the following fields:
    • event_type (string, always "claim")
    • timestamp (string, date-time)
    • phase (string) — Support Automation ticket stage
    • sub_status (string) — ticket sub-status
    • category (string) — ticket category (e.g. lost, damaged, delayed)
    • ticket_id (integer) — Support Automation ticket identifier
    • claim_event_id (integer) — claim event identifier
    • refund_price (object or null) — refund amount in original currency
    • refund_price_eur (object or null) — refund amount converted to EUR
    • request_id (integer or null) — status update identifier for document uploads
    • attachment_type (string or null) — requested attachment type, if any
    • title (string or null) — human-readable title for the ticket update
    • message (string or null) — human-readable message for the ticket update
    • resolution (string or null) — reason the ticket was solved; only present on solved statuses
    • origin (string or null) — who or what created the investigation (e.g. ava, public, panel)
  • New examples added: ClaimTicketCreated, ClaimActionRequired, ClaimResolved
  • Tracking Event event_type values now limited to carrier and calculated
  • Tracking Event phase values updated: removed announced, announcing, no_label, ready_to_send
  • Tracking Event sub-status values updated: removed one, two, three; added '1', '2', '3'

​

Changed endpoints:

• Changes for webhook parcels.event.created:
  • Summary renamed from “Parcel event created” to “Parcels event created”

​

Changed endpoints:

• Changes for POST /orders and PATCH /orders/{id}:
  • Field cpsc added to order items (optional). Contains CPSC (Consumer Product Safety Commission) certification details (product_id, certifier_id, version_id) required for certain shipments to the United States. If provided, all three fields are required
• Changes for GET /orders and GET /orders/{id}:
  • Field cpsc added to order items in response

​

Changed endpoints:

• Changes for POST /orders/create-label:
  • In the LabelsSuccessfulWithShipWith response example, field parcel_ids added to each returned parcel object

​

Changed endpoints:

• Changes for POST /orders/create-label and shipment-related endpoints:
  • Field documents.type: description updated to clarify it is deprecated in favor of document_type
  • Field documents.document_type: description updated to explain how each value maps to the deprecated type field values (label, customs-declaration, air-waybill)

​

Changed endpoints:

• Changes to the parcel status changed webhook payload:
  • Field date_created: description updated to clarify format (DD-MM-YYYY HH:MM:SS, UTC); example updated accordingly
  • Field status: description updated to clarify it does not include a status code, and that id should be used to identify the status
  • Field tracking_url added: URL where the recipient can track the parcel
  • Field delivery_dates added: planned handover and delivery dates in ISO 8601 format (UTC)
  • Field carrier added: object containing the carrier id, code, name, and servicepoints_carrier_code
  • Field is_return added: whether the parcel is a return parcel
  • Field date_updated added: date and time of when the parcel was last updated
  • Field date_announced added: date and time of when the parcel was announced to the carrier
  • Field colli_uuid added: unique identifier shared by all parcels of a multicollo shipment
  • Field collo_nr added: position of the parcel within a multicollo shipment
  • Field collo_count added: total number of parcels in the shipment

​

Changed endpoints:

• Changes for POST /orders/create-label-async:
  • Field parcels_ids renamed to parcel_ids in response 202 schema
  • Description updated for deprecated parcel_id field: now references parcel_ids instead of parcels_ids
• Changes for POST /orders/create-label-sync:
  • Request: field order should be a single object (not an array) in both examples
  • Response 201: field data changed from a single object to an array of objects, each containing parcel ID, tracking details, and generated label
  • Response field label_details renamed to label
  • Field dpi in label request: valid values depend on format (PNG and ZPL support 203, 300, 600); PDF defaults to 72
  • Field dpi in label response: example updated from 72 to 203

​

Changed endpoints:

• Changes for POST /api/v3/duties-and-taxes/calculate (Duties and Taxes API):
  • The currency field in price objects now accepts any valid three-letter ISO 4217 currency code instead of being restricted to EUR, GBP, or USD
• Changes for all endpoints using price objects (Orders API):
  • The currency field in price objects now accepts any valid three-letter ISO 4217 currency code instead of being restricted to EUR, GBP, or USD
• Changes for POST /api/v3/returns and PATCH /api/v3/returns/{id} (Returns API):
  • The total_insured_value.currency field now supports SEK and DKK in addition to EUR, GBP, and USD
  • The currency field in total_order_value price objects now accepts any valid three-letter ISO 4217 currency code instead of a fixed pattern
• Changes for all endpoints using price objects (Shipping Options API):
  • The currency field in price objects now accepts any valid three-letter ISO 4217 currency code instead of being restricted to EUR, GBP, or USD
• Changes for POST /api/v3/dsf/requested-data and related fields (Support API):
  • The currency field now accepts any valid three-letter ISO 4217 currency code instead of being restricted to EUR, GBP, or USD

​

Changed endpoints:

• Changes for customs information across shipment and return creation endpoints:
  • customs_information is now required when customs documents are needed. For shipments, this applies to shipments from the EU to a non-EU destination. For returns, this applies unless customs_invoice_nr is provided.
  • Field importer_of_record.state_province_code: must use the ISO 3166-2 code with country prefix (e.g. US-NY for New York, IT-RM for Rome). Vietnam added to the list of destinations that require this field.

​

Changed endpoints:

• Changes for GET /api/v3/parcel-tracking/{id} and related tracking endpoints:
  • Field status_code removed from parcel event response
  • Field status_description removed from parcel event response
  • Field sub_status_code removed from parcel event response
  • Field phase added to parcel event response (nullable string; the main delivery process step, e.g. in_transit or delivered)
  • Field exception added to parcel event response (nullable string; describes what went wrong, e.g. delivery_delay; none when no exception)
  • Field sub_status added to parcel event response (nullable string; additional detail about phase and exception; none when no detail applies)
  • Field description added to parcel event response (nullable string; human-readable description of the event)
  • Field status_type changed to nullable and now restricted to enum values: success, warning, error, null

​

Changed endpoints:

• Changes for POST /api/v3/shipments/announce:
  • Documentation updated: added currency conversion notice clarifying that Sendcloud does not convert currencies and that incorrect values can cause customs delays
• Changes for POST /api/v3/shipments:
  • Documentation updated: added currency conversion notice clarifying that Sendcloud does not convert currencies and that incorrect values can cause customs delays

​

Changed endpoints:

• Changes for POST /api/v3/parcel-tracking:
  • Field brand_id description updated: link to Brands API now points to /api/v3/brands/retrieve-a-list-of-brands
• Changes for POST /api/v3/returns:
  • Field brand_id description updated: link to Brands API now points to /api/v3/brands/retrieve-a-list-of-brands. Description now clarifies that if brand_id is not specified, no brand is applied to the return.
• Changes for POST /api/v3/ship-an-order:
  • Field brand_id description updated: link to Brands API now points to /api/v3/brands/retrieve-a-list-of-brands. Description now clarifies brand resolution order when brand_id is not specified (sender address brand is used, with shipping rules taking precedence).
• Changes for shipment create/update endpoints:
  • Field brand_id description updated: link to Brands API now points to /api/v3/brands/retrieve-a-list-of-brands. Description now clarifies that when a shipment is created without a brand_id, the brand of the sender address is used; if a full from_address is provided instead, no brand is applied.

​

Changed endpoints:

• Changes for POST /api/v3/parcel-tracking:
  • Field insurance.currency removed
  • Field insurance.value removed
  • Field insurance.insured_value added (object containing currency and value)

​

Changed endpoints:

• Changes for POST /api/v3/shipments and PATCH /api/v3/shipments/{id}:
  • Field carrier_specific.time_slot_booking_delivery added to DHL Freight shipment extras: when true, the shipment will not be delivered until a delivery date has been confirmed with DHL Freight over the phone

​

Changed endpoints:

• Changes for GET /api/v3/invoice-items:
  • Field subtype added to response items
  • Example updated: second item now shows type: surcharge with subtype: dimensional
• Changes for GET /api/v3/invoice-items/{invoice_item_id}:
  • Field subtype added to response (identifies the specific surcharge type for surcharge items, such as dimensional or drop_off_surcharge; null when not applicable)

​

Changed endpoints:

• Changes for GET /invoice-items:
  • Endpoint is now stable (previously in beta)
• Changes for GET /invoice-items/{invoice_item_id}:
  • Endpoint is now stable (previously in beta)
• Changes for GET /invoices:
  • Endpoint is now stable (previously in beta)
• Changes for GET /invoices/{invoice_id}:
  • Endpoint is now stable (previously in beta)

​

Changed endpoints:

• Changes for POST /api/v3/shipments and related shipment endpoints:
  • Field cpsc removed from customs_information object
  • Field cpsc added to each parcel item — provides CPSC (Consumer Product Safety Commission) certification details (product_id, certifier_id, version_id) per item; omit if not applicable

​

Changed endpoints:

• Documentation fix for the shared dangerous_goods object on every endpoint that accepts or returns parcel items (Orders, Shipments, Returns and Parcel Tracking):
  • Field unit_of_measurement is now documented with its actual accepted values kg, g, l and ml (previously documented as KG, G, L and ML)
  • Field weight_type is now documented with its actual accepted values net and gross (previously documented as Net and Gross)
  The API has only ever accepted and returned these lowercase values — the uppercase spellings were a documentation error and were never valid. No request that works today is affected.

​

Changed endpoints:

• Changes for POST /api/v3/shipments and related shipment creation endpoints:
  • Field customs_information.cpsc added: an optional map of SKU to CPSC (Consumer Product Safety Commission) certification details, required for certain shipments to the United States. Each key is a SKU matching a parcel item, and each value contains product ID, certifier ID, and version ID.

​

Changed endpoints:

• Changes for POST /api/v3/orders and PATCH /api/v3/orders/{id}:
  • service_point_details: Service Points API references updated to v3
• Changes for POST /api/v3/shipments:
  • service_point: Service Points API references updated to v3
• Changes for GET /api/v3/shipping-options and POST /api/v3/shipping-options/filter:
  • to_service_point_id (deprecated): Service Points API references updated to v3
  • to_service_point: Service Points API references updated to v3

​

Changed endpoints:

• Changes for POST /oauth2/token:
  • grant_type field now restricted to client_credentials only (previously accepted multiple grant types)
  • Fields code, redirect_uri, and refresh_token removed from request body
  • Field scope added to request body (must be set to api)
  • Field client_id now optional when using HTTP Basic authentication
  • Response schema fields id_token and refresh_token removed
  • Field expires_in description updated to clarify tokens expire ~1 hour after issuance
  • Only HTTP Basic authentication is now accepted (OAuth 2.0 authentication method no longer supported)
  • Endpoint documentation updated

​

Added endpoints:

• POST webhooks/ParcelCreated — New parcel.created webhook event delivered when a parcel is created in Sendcloud. The payload includes:
  • Parcel identifiers (id, created_at, updated_at, announced_at, organization_id)
  • Shipping option (ship_with) with type and properties (shipping_option_code, contract_id)
  • Tracking numbers (carrier_code, tracking_number, tracking_identifier, tracking_url)
  • Parcel details (is_return, brand_id, integration_id, external_reference, dimensions, weight)
  • Order data (order_number, ordered_at, total_price) — null when not linked to an order
  • Sender and recipient addresses (from_address, to_address)
  • Parcel items (parcel_items) with fields: item_id, description, product_id, variant_id, quantity, sku, hs_code, country_of_origin, unit_price

​

Changed endpoints:

• Changes for POST /shipping-options:
  • Field quote_source added to shipping option response objects. Indicates which pricing source was used (or attempted): sendcloud_prices, csv_upload, carrier_api, pricing_form, or sendcloud_prices_api. Returns null when quoting was not requested or no pricing path exists.
  • Field quote_error added to shipping option response objects. Contains error details (code, title, description) when a pricing attempt failed for an option; null otherwise.

​

Changed endpoints:

• Changes for POST /v3/pickups (DHL pickup request):
  • The quantity field is no longer required for DHL pickup requests

​

Changed endpoints:

• Changes for POST /api/v3/shipments and PATCH /api/v3/shipments/{id}:
  • Field carrier_specific (shipment extras) now supports DHL Freight with the following new fields:
    • tail_lift_loading: Request a tail lift at pickup
    • tail_lift_unloading: Request a tail lift at the delivery address
    • fixed_delivery_date: Request delivery on a specific calendar date (date in yyyy-mm-dd format)

​

Changed endpoints:

• Changes for POST /api/v3/support/tickets:
  • Response 422 description updated: now covers two distinct failure cases — deflection rules blocking the request, and portal claim requested without portal contract credentials
  • Response 422 examples expanded:
    • “Deflection rules violation (generic)” example added
    • “Deflection rules violation (duplicate ticket)” example added
    • “Deflection rules violation (own contract carrier)” example added
    • “Deflection rules violation (carrier support contact not configured)” example added
    • “Portal claim requested without a portal contract” example added
    • Previous generic “Deflection rules violation” and “Carrier support contact is missing for own contract parcel” examples replaced

​

Changed endpoints:

• Changes for POST /api/v3/dsf/files:
  • Maximum file size increased from 6 MB to 10 MB
  • Response 413 description updated to reflect new 10 MB limit

​

Changed endpoints:

• Changes for POST /api/v3/orders and GET /api/v3/orders/{id}:
  • Field dds_reference added to order line items (DDS reference number under the EU Deforestation Regulation)
  • Field taric_code added to order line items (TARIC code for EU customs classification)

​

Changed endpoints:

• Changes for GET /api/v3/returns:
  • Field tracking_numbers added to return object in response, containing an array of tracking number objects with a tracking_number string field

​

Added endpoints:

• GET /api/v3/shipping-defaults — Retrieve the shipping defaults configured for your account (weight, shipping method, insurance, customs options, and label options).
• PATCH /api/v3/shipping-defaults — Update one or more shipping defaults for your account. Only the fields you send are changed; send null for ship_with or insurance to remove that default.

​

Changed endpoints:

• Changes for POST /api/v3/shipments:
  • Field delivery_dates.earliest_delivery_time added: earliest local time of day for delivery, in HH:MM format
  • Field delivery_dates.latest_delivery_time added: latest local time of day for delivery, in HH:MM format

​

Changed endpoints:

• Changes for address validation response:
  • Field invalid_attributes added to the analysis object, listing attributes that are invalid (i.e. below the field-level validation threshold)

​

Changed endpoints:

• Changes for GET /api/v3/events:
  • Field actor_id added to the event response

​

Changed endpoints:

• Changes for webhook POST parcels.event.created:
  • Field order_number added to the parcel object in the event payload

​

Changed endpoints:

• Changes for POST /api/v3/shipments/announce:
  • Field tracking_numbers added to parcel objects in response 201
• Changes for GET /api/v3/shipments:
  • Field tracking_numbers added to parcel objects in response 200
• Changes for POST /api/v3/shipments:
  • Field tracking_numbers added to parcel objects in response 201
• Changes for POST /api/v3/shipments/announce-with-rules:
  • Field tracking_numbers added to parcel objects in response 201
• Changes for POST /api/v3/shipments/with-rules:
  • Field tracking_numbers added to parcel objects in response 201
• Changes for GET /api/v3/shipments/{id}:
  • Field tracking_numbers added to parcel objects in response 200

​

Changed endpoints:

• Changes for POST /api/v3/shipments and POST /api/v3/shipments/announce:
  • Field carrier_fields at the parcel level now supports Chronopost with expiration_date (string or null, yyyy-mm-dd): the best-before date of the parcel’s contents. Required when shipping with a Chronopost Chrono Fresh product, in which case it must be at least 5 days from the current date; ignored for other Chronopost products.

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Parcel item field price renamed to price_per_item (price of a single item, per unit). The deprecated price key is still accepted and will be removed in a future version.

​

Changed endpoints:

• Changes for POST /api/v3/dsf/tickets/requested-data:
  • sales_data item field selling_price renamed to selling_price_per_item (selling price per single item, tax-included). The deprecated selling_price key is still accepted and will be removed in a future version.

​

Changed endpoints:

• Changes for GET /api/v3/dsf/tickets:
  • Parameter tracking_number added (filter by parcel tracking number)
• Changes for GET /api/v3/dsf/tickets/{ticket_id}:
  • Response 200: Field tracking_number added to ticket object

​

Changed endpoints:

• Changes for POST /api/v3/sync/shipments:
  • Response 409 added: returns the existing shipment when a duplicate external_reference_id is detected
• Changes for POST /api/v3/shipments:
  • Response 409 added: returns the existing shipment when a duplicate external_reference_id is detected
• Changes for POST /api/v3/sync/shipments (with shipping rules):
  • Response 409 added: returns the existing shipment when a duplicate external_reference_id is detected
• Changes for POST /api/v3/shipments (with shipping rules):
  • Response 409 added: returns the existing shipment when a duplicate external_reference_id is detected

​

Added endpoints:

• GET /shipping-rules/rules
• POST /shipping-rules/rules
• POST /shipping-rules/rules/reorder
• GET /shipping-rules/rules/{rule_id}
• PATCH /shipping-rules/rules/{rule_id}
• DELETE /shipping-rules/rules/{rule_id}
• GET /shipping-rules/actions
• GET /shipping-rules/actions/{identifier}
• GET /shipping-rules/operators
• GET /shipping-rules/conditions
• GET /shipping-rules/conditions/{identifier}

​

Changed endpoints:

• Changes for POST /api/v3/orders and PATCH /api/v3/orders/{id}:
  • Field service_point_details: This field is for API usage only and will not be reflected in the Incoming Order View (IOV)

​

Changed endpoints:

• Changes for GET /api/v3/parcels/{id}/documents/{type}:
  • Added a new proof-of-delivery document type. It is retrieved directly from the carrier on request, is only available once the parcel has been delivered, and is only returned in PDF format (application/pdf). Availability depends on the carrier supporting proof of delivery.

​

Changed endpoints:

• Changes for GET /api/v3/shipping-options:
  • Field lead_time in the response is now nullable (previously required integer, now integer or null)

​

Changed endpoints:

• Corrected the Shipments API response field name from delivery-dates to delivery_dates.

​

Changed endpoints:

• Changes for POST /api/v3/shipments and POST /api/v3/shipments/announce:
  • parcel_items array now accepts two distinct item types based on shipment destination:
    • Domestic shipments: quantity defaults to 1, weight defaults to 0.001 kg, and price defaults to 0.00 if not provided
    • International shipments: description, quantity, weight, price, hs_code, and origin_country are required
  • Field descriptions for hs_code and origin_country updated to clarify requirements based on shipment type
• Changes for GET /api/v3/shipments/{id} and related shipment response endpoints:
  • parcel_items in responses now always includes all fields: hs_code, weight, description, price, and quantity

​

Deprecated endpoints:

• GET /api/v3/checkout/configurations/{configuration_id}/delivery-options — Deprecated as of June 9, 2026. Use POST /api/v3/checkout/delivery-options instead, which does not require a configuration_id in the URL and accepts cart and order details in a request body.

​

Changed endpoints:

• GET /api/v3/service-points — Now generally available.
• GET /api/v3/service-points/{service_point_id} — Now generally available.
• POST /api/v3/service-points/{service_point_id}/check-availability — Now generally available.

​

Added endpoints:

• GET /api/v3/invoice-items
• GET /api/v3/invoice-items/{invoice_item_id}

• GET /api/v3/invoices
• GET /api/v3/invoices/{invoice_id}

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Response 409 now only occurs during concurrent race conditions; duplicate submissions now return 200 instead
  • Response now includes created field (boolean) indicating whether the parcel was newly created (true) or already existed (false); the endpoint is now idempotent based on source_id, carrier_code, and organization

​

Changed endpoints:

• Changes for shipment creation endpoints:
  • carrier_shipment_extras: Now explicitly supports an empty object, clarifying that the field can be omitted for carriers without declared shipment-level extras
  • carrier_parcel_extras: Now explicitly supports an empty object, clarifying that the field can be omitted for carriers without declared parcel-level extras

​

Changed endpoints:

• Changes for POST /api/v3/dsf/files:
  • Response 415 added: file type not allowed
  • Response 400 error message updated to clarify that the file field is required
  • Response 413 description updated to clarify maximum file size is 6 MB
  • Field file in request body: description added, documenting filename requirement, content type rules, and 6 MB size limit
  • Documentation expanded with guidance on multipart/form-data requirements, allowed content types, size limits, and error meanings

​

Added endpoints:

• POST /checkout/delivery-options: Generate a list of delivery options based on cart or order details. This endpoint uses the currently active Dynamic Checkout configuration for the authenticated API integration — no configuration_id is required. Returns 400 if no published configuration exists for the integration.

​

Changed endpoints:

• Changes for GET /checkout/{configuration_id}/delivery-options:
  • Response 400 and 404 error examples updated: status values corrected from integers to strings

​

Changed endpoints:

• Changes for POST /api/v3/shipments (and related shipment creation endpoints):
  • Field carrier_fields added to shipment-level request body: optional carrier-specific shipment-level fields; currently supports DHL Express with hide_sender (boolean or null) to omit the sender address from the shipping label
  • Field carrier_fields added to parcel-level request body: optional carrier-specific parcel-level fields; currently supports Dynalogic with collo_barcode (string or null) to override the collo barcode reported to Dynalogic

​

Changed endpoints:

• Changes for POST /api/v3/shipments (and related shipment creation endpoints):
  • Field export_reason now accepts two additional values: returned_goods and personal_use
• Changes for POST /api/v3/returns (and related return creation endpoints):
  • Field export_reason now accepts an additional value: personal_use

​

Changed endpoints:

• Changes for POST /shipments and POST /shipments/announce-with-shipping-rules:
  • Field manufacturer_product_id added to parcel items (optional, max 70 characters)
  • Field manufacturer_product_id_std added to parcel items (optional, max 70 characters; use for standardized identifiers such as GTIN)
• Changes for GET /shipments/{id}:
  • Field manufacturer_product_id added to parcel items in response
  • Field manufacturer_product_id_std added to parcel items in response
• Changes for parcel tracking:
  • Field manufacturer_product_id added to parcel items (optional, max 70 characters)
  • Field manufacturer_product_id_std added to parcel items (optional, max 70 characters)
• Changes for Returns API:
  • Fields dangerous_goods, dds_reference, and taric_doc_code added to return parcel items
  • Field manufacturer_product_id added to return parcel items (optional, max 70 characters)
  • Field manufacturer_product_id_std added to return parcel items (optional, max 70 characters)

​

Changed endpoints:

• Changes for POST /api/v3/support/tickets:
  • Response field ticket_id type changed from string to integer

​

Added endpoints:

• GET /api/v3/analytics/transit-times/carriers — Returns aggregated transit-time statistics per carrier, filterable by origin/destination country and date window. Marked as Beta.
• GET /api/v3/analytics/transit-times/shipping-options — Returns aggregated transit-time statistics per shipping option, filterable by origin/destination country and date window. Marked as Beta.

​

Added endpoints:

• POST /api/v3/reporting/parcels — Create a parcels report (CSV export of outgoing or incoming parcels); returns a report id and initial status
• GET /api/v3/reporting/parcels/{report_id} — Retrieve a parcels report by id; poll until status is ready, then download the CSV from the url field

​

Changed endpoints:

• Changes for POST /api/v3/support/tickets:
  • Response 202: ticket_id is now returned as a numeric integer instead of a UUID string

​

Changed endpoints:

• GET /api/v3/integrations: OAuth2 authentication is now supported
• GET /api/v3/integrations/{id}: OAuth2 authentication is now supported
• PATCH /api/v3/integrations/{id}: OAuth2 authentication is now supported
• DELETE /api/v3/integrations/{id}: OAuth2 authentication is now supported
• GET /api/v3/integrations/logs: OAuth2 authentication is now supported
• GET /api/v3/integrations/{id}/logs: OAuth2 authentication is now supported
• POST /api/v3/integrations/{id}/logs: OAuth2 authentication is now supported
• GET /api/v3/shop-order-statuses: OAuth2 authentication is now supported
• POST /api/v3/shop-order-statuses: OAuth2 authentication is now supported
• GET /api/v3/shop-order-statuses/mapping: OAuth2 authentication is now supported
• POST /api/v3/shop-order-statuses/mapping: OAuth2 authentication is now supported

​

Changed endpoints:

• Changes for GET /api/v3/service-points:
  • Endpoint is now publicly visible
  • Parameter country_code now has a maximum length of 2 characters
  • Field geocoding.formatted_address added to the 200 response
  • Field geocoding.status now supports a new partially_matched value
  • Field geocoding.precision now supports a new region value
  • Response 400 now includes new error examples for service points not enabled for an integration and unsupported carriers
  • Response 503 added for cases where address geocoding is temporarily unavailable
  • Documentation updated: clarified that address_house_number must be combined with address_street or address_postal_code; clarified that bounding box diagonal must not exceed 50 km; added guidance on partially_matched geocoding status
• Changes for GET /api/v3/service-points/{service_point_id}:
  • Endpoint is now publicly visible
• Changes for POST /api/v3/service-points/{service_point_id}/check-availability:
  • Endpoint is now publicly visible

​

Changed endpoints:

• Changes for POST /addresses/validate:
  • Description updated to clarify the validation process: carrier limit checks and address optimization
  • Response 200 schema updated:
    • Field input_address_is_valid added (boolean, indicates if the input address is valid)

​

Changed endpoints:

• Changes for POST /shipments:
  • Field package_type added to parcel objects in the response
• Changes for GET /shipments:
  • Field package_type added to parcel objects in the response
• Changes for GET /shipments/{id}:
  • Field package_type added to parcel objects in the response

​

Added fields:

• Field package_type added to parcel objects. Defines how parcels are packed (e.g., package, euro_pallet, block_pallet, mini_pallet, one_way_pallet, tube, over_size_pallet, bundle, half_pallet, letterbox). Required for carriers with specific packaging needs such as pallet carriers.

​

Added endpoints:

• POST /api/v3/shipping/duties-and-taxes — Calculate import duties and taxes for an international shipment. Returns per-item duty and tax breakdown, shipment-level totals, and destination country de minimis thresholds. Currently in beta and available to enterprise customers only.

​

Changed endpoints:

• Changes for Ship an Order API document responses:
  • Field type in documents object marked as deprecated
  • Field type enum expanded with new values: cn23, cp71, cn23-default, qr
  • Field document_type added to documents object with values: label, customs-declaration, air-waybill
• Changes for Shipments API document responses:
  • Field type in documents object marked as deprecated
  • Field type enum expanded with new values: cn23, cp71, cn23-default, qr
  • Field document_type added to documents object with values: label, customs-declaration, air-waybill

​

Changed endpoints:

• Changes across Orders API, Parcel Tracking API, Pickups API, Returns API, Sender Addresses API, and Shipments API:
  • Field state_province_code description updated to clarify it is required for certain countries, with a link to international shipping documentation
• Changes for Returns API and Shipments API customs information:
  • Field state_province_code description updated to clarify it is required for certain countries (USA, Canada, Italy, Australia), with a link to international shipping documentation
• Changes for Pickups API pickup address:
  • Field state_province_code description updated to clarify it is required for certain countries, with a link to international shipping documentation

​

Changed endpoints:

• Changes for POST /api/v3/shipments/address-washer:
  • Fixed typo in validation_methods field description (“optinal” → “optional”)

​

Changed endpoints:

• Shipping option address fields no longer have default values:
  • postal_code
  • address_line_1
  • city

​

Changed endpoints:

• Changes for POST /shipping-options:
  • Field state_province_code example updated to RM-IT

​

Changed endpoints:

• Changes for GET /parcels/tracking/{tracking_number}:
  • Bearer token authentication removed as a supported authentication method
• Changes for POST /parcels/tracking:
  • Bearer token authentication removed as a supported authentication method

​

Changed endpoints:

• Changes for POST /shipping-options:
  • Field from_address added to request body — accepts an address object with country_code, postal_code, address_line_1, city, and state_province_code fields. Cannot be combined with from_country_code or from_postal_code.
  • Field to_address added to request body — accepts an address object with country_code, postal_code, address_line_1, city, and state_province_code fields. Cannot be combined with to_country_code or to_postal_code.
  • Field from_country_code deprecated. Use from_address instead.
  • Field to_country_code deprecated. Use to_address instead.
  • Field from_postal_code deprecated. Use from_address instead.
  • Field to_postal_code deprecated. Use to_address instead.

​

Changed endpoints:

• Changes for POST /shipments/announce-with-shipping-rules:
  • Documentation updated to clarify that from_address, ship_with, and parcels fields must be provided if no shipping rules or defaults are configured to assign them automatically
• Changes for POST /shipments/create-with-shipping-rules:
  • Documentation updated to clarify that from_address, ship_with, and parcels fields must be provided if no shipping rules or defaults are configured to assign them automatically

​

Changed endpoints:

• Changes for POST /api/v3/shipments:
  • Field validation_methods description expanded to clarify behavior when using the “Here” validation method: Sendcloud will attempt to verify and correct the provided address based on the best available match; if no suitable match is found, the request returns an error; only address components recognised by the provider will be kept, and additional details (e.g. delivery notes) should be passed via parcels.label_notes instead

​

Removed endpoints:

• GET /event-subscriptions/connections/authorization/callback

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Documentation updated

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Documentation updated to note that including shipping_option_code in the ship_with property is required for parcels to appear in Analytics

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Summary updated from “Create a tracking-only parcel” to “Create an external parcel for tracking”
  • Description updated to clarify the endpoint registers an external parcel for tracking

​

Added endpoints:

• GET /api/v3/service-points — Search for service points by carrier, country, location (coordinates, free-text address, or structured address), bounding box, or carrier-specific identifiers. Supports filtering by shop type and search radius.
• GET /api/v3/service-points/{service_point_id} — Retrieve a single service point by its Sendcloud identifier.
• POST /api/v3/service-points/{service_point_id}/check-availability — Check whether a specific service point is currently available.

​

Changed endpoints:

• Changes for POST /api/v3/shipments and PUT /api/v3/shipments/{id}:
  • Field from_address is now explicitly required on shipment request and response objects
  • Field from_address now accepts either a full address object or a sender_address_id referencing a pre-configured sender address
  • When using sender_address_id, if the referenced sender address has a brand or tax numbers configured, those will be used by default. However, explicitly provided brand_id or tax_numbers in the request will take precedence

​

Added endpoints:

• GET /api/v3/dsf/tickets — Retrieve a paginated list of support tickets with optional filters for status, carrier, parcel ID, and date range
• GET /api/v3/dsf/tickets/{ticket_id} — Retrieve a single support ticket by ID

​

Changed endpoints:

• GET /api/v3/dsf/tickets:
  • Query parameters added: page, size, status, parcel_id, carrier, created_after, created_before
  • Response includes paginated results with: total, page, pages, size, items
  • Each ticket includes: id, status, stage, type, parcel_id, carrier, order_number, brand_id, created_at, updated_at, requested_actions, resolution
  • Response 400 added for invalid filter values
• GET /api/v3/dsf/tickets/{ticket_id}:
  • Response includes ticket fields: id, status, stage, type, parcel_id, carrier, order_number, brand_id, created_at, updated_at, requested_actions, resolution
  • Response 404 added when ticket does not exist or does not belong to the organization

​

Changed endpoints:

• Changes for POST /api/v3/support/provide-requested-data:
  • Field sales_date added to sales_data array items — an optional date-time field specifying the date of the sale, used as the invoice date when generating sales invoices; if omitted, the parcel announcement date is used

​

Added endpoints:

• POST webhooks/ParcelEventCreated — Webhook event delivered to your connection endpoint when a parcel tracking event occurs (e.g., status changes such as shipped, delivered, or returned). Subscribe using event type parcels.event.created.

​

Removed endpoints:

• GET /event-subscriptions/connections/type/{connection_type}

​

Changed endpoints:

• POST /event-subscriptions/broadcast/test/{subscription_id}:
  • Summary updated from “Test event delivery” to “Broadcast test event”

​

Removed endpoints:

• GET /event-subscriptions/subscriptions/event/{event_type}

​

Changed endpoints:

• Changes for GET /event-subscriptions/connections:
  • Query parameter connection_type added (enum: webhook, klaviyo) — filter connections by type
• Changes for GET /event-subscriptions/subscriptions:
  • Query parameter event_type added — filter subscriptions by event type
  • Query parameter is_active added — filter subscriptions by active status

​

Changed endpoints:

• Changes for POST /api/v3/shipments (sync) and POST /api/v3/shipments (async):
  • Field goods_description added to customs_information request body and response (optional string, max 255 characters; used for customs clearance purposes — note: not supported by all carriers)
  • Field general_notes in customs_information no longer has a minimum length requirement

​

Changed endpoints:

• Changes for POST /api/v3/shipments/announce (announce shipment with rules):
  • Response 201 now includes field applied_shipping_rules — a list of shipping rules that were applied to the shipment, each containing the rule id, rule name, and a result object describing the modifications made
• Changes for POST /api/v3/shipments (create shipment with rules):
  • Response 201 now includes field applied_shipping_rules — a list of shipping rules that were applied to the shipment, each containing the rule id, rule name, and a result object describing the modifications made

​

Changed endpoints:

• Changes for POST /shipping-options:
  • Field message added to response 200 / application/json

​

Changed endpoints:

• Changes for POST /api/v3/support/provide-requested-data:
  • Field request_id description updated with reference to the GET endpoint for retrieval
  • Field comment description clarified as optional
  • Field attachments description updated with links to file upload and document generation endpoints
  • Field attachments[].file_token description updated to reference the file upload endpoint
  • Field sales_data description clarified as required when data_type is sales_data
  • Field force added (boolean, default false): bypasses the maximum invoice amount validation of 5000 EUR
  • Response 404 now returns request_id not found detail instead of generic Not found
  • Documentation updated: clarified that comment field is not required for providing data contents
  • Example updated to include force: true for sales data requests
• Changes for POST /api/v3/support/generate-claim-letter:
  • Documentation updated: the generated PDF returns a file token usable with the Create a requested data response endpoint or when creating tickets

​

Changed endpoints:

• Changes for POST ParcelStatusChanged:
  • Description updated to clarify that only parcels created through the specific integration will trigger this webhook

​

Changed endpoints:

• Changes for POST /shipment (sync):
  • Response 201 / application/json changed:
    • Field carrier added to shipment response object (contains code and name subfields)
• Changes for POST /shipments (async):
  • Response 201 / application/json changed:
    • Field carrier added to shipment response object (contains code and name subfields)
• Changes for POST /shipments (with rules):
  • Response 201 / application/json changed:
    • Field carrier added to shipment response object (contains code and name subfields)
• Changes for base-shipment-response schema:
  • Field carrier added: a read-only object containing carrier code (Sendcloud unique identifier) and name (friendly name)

​

Changed endpoints:

• Changes for last_mile field in shipping product/method properties (Returns API and Shipping Options API):
  • Enum value pobox removed from last_mile field
  • Enum value locker added to last_mile field (shipment delivered to a locker)
  • Enum value locker_or_service_point added to last_mile field (shipment delivered to a locker or a service point)
  • Fixed typo in MAILBOX description: recepient → recipient

​

Added endpoints:

• POST /api/v3/dsf/documents/generate/invoice — Generate a sales invoice PDF for a parcel
• POST /api/v3/dsf/documents/generate/claim-letter — Generate a claim letter PDF for a parcel

​

Changed endpoints:

• Changes for POST /api/v3/dsf/files:
  • Description updated: file token can now be used when attaching files to tickets or when submitting requested data
  • Response 429 now references endpoint-specific rate limit response (30 requests per minute)
• Changes for GET /api/v3/dsf/carrier-support-contacts:
  • Response 429 added
• Changes for PATCH /api/v3/dsf/carrier-support-contacts/{id}:
  • Response 429 added
• Changes for DELETE /api/v3/dsf/carrier-support-contacts/{id}:
  • Response 429 added
• Changes for POST /api/v3/dsf/tickets/damage:
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for POST /api/v3/dsf/tickets/delay:
  • deprecated: true flag removed
  • Description updated: endpoint now explicitly scoped to Sendcloud rates parcels only
  • Request body no longer accepts own contract parcel schema (CreateDelayedOwnContract); only CreateDelayedTransactional is accepted
  • Schema CreateDelayedOwnContract removed
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for POST /api/v3/dsf/tickets/late-delivery:
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for POST /api/v3/dsf/tickets/lost:
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for POST /api/v3/dsf/tickets/delivered-but-not-received:
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for POST /api/v3/dsf/tickets/unjust-return:
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for POST /api/v3/dsf/tickets/address-change:
  • Response 429 now references endpoint-specific rate limit response (15 requests per minute)
• Changes for GET /api/v3/dsf/tickets/requested-data (previously /support/dsf/tickets/requested-data):
  • Path corrected to /api/v3/dsf/tickets/requested-data
  • data_type enum values reduced to: claim_letter, sales_invoice, sales_data, purchase_invoice, description_of_contents
  • Response 429 added
• Changes for POST /api/v3/dsf/tickets/requested-data:
  • Endpoint summary updated to “Create a requested data response”
  • Accepted data_type values for file attachments reduced to: sales_invoice, purchase_invoice, claim_letter
  • Accepted data_type values for textual input reduced to: description_of_contents
  • Field selling_price description updated: value must now be tax-included
  • Response 429 added

​

Added endpoints:

• GET /brands
• GET /brands/{id}

​

Changed endpoints:

• Changes for POST /returns:
  • Documentation updated: label retrieval now references Retrieve a parcel document endpoint instead of the v2 Labels API
• Changes for GET /returns:
  • Field shipping_option added to Return response object
  • label_url example URLs updated from v2 Labels API (/api/v2/labels/...) to v3 Parcel Documents API (/api/v3/parcels/{id}/documents/label)
  • label.label_printer example URL updated to v3 Parcel Documents API
  • label.normal_printer example URLs updated to v3 Parcel Documents API; description updated to clarify the array always contains 4 identical URLs for backward compatibility
• Changes for GET /returns and GET /returns/{id} (Return schema):
  • Field shipping_option added (object with nullable code string referencing the shipping option code)
  • label_url example updated to v3 Parcel Documents API URL format
  • label.label_printer example updated to v3 Parcel Documents API URL format
  • label.normal_printer description and examples updated to v3 Parcel Documents API URL format
  • shipping_option added to required fields

​

Added endpoints:

• GET /shipments/{id}/return-portal-url

​

Changed endpoints:

• Changes for GET /support/dsf/tickets/requested-data:
  • Added page query parameter (integer, default: 1)
  • Added size query parameter (integer, default: 50, maximum: 100)
  • Response 200 schema changed:
    • Field data removed from required properties and replaced with items
    • Field total added (integer, total number of items across all pages)
    • Field page added (integer, current page number)
    • Field pages added (integer, total number of pages)
    • Field size added (integer, number of items per page)
    • Field items added (array, replaces data array)
    • Field description removed from individual item objects
• Changes for POST /support/dsf/tickets/requested-data:
  • Response 400 now references ProvideRequestedDataBadRequest instead of BadRequestResponse, adding more specific error examples: validation errors, action not allowed, and sales data required

​

Changed endpoints:

• Changes for POST IntegrationConnected webhook:
  • Operation ID updated from sc-public-v2-webhooks-integration_connected to sc-public-v3-webhooks-integration_connected
• Changes for POST IntegrationDeleted webhook:
  • Operation ID updated from sc-public-v2-webhooks-integration_deleted to sc-public-v3-webhooks-integration_deleted
• Changes for POST IntegrationModified webhook:
  • Operation ID updated from sc-public-v2-webhooks-integration_modified to sc-public-v3-webhooks-integration_modified
• Changes for POST ParcelStatusChanged webhook:
  • Operation ID updated from sc-public-v2-webhooks-parcel_status_changed to sc-public-v3-webhooks-parcel_status_changed
• Changes for POST ReturnCreated webhook:
  • Operation ID updated from sc-public-v2-webhooks-return_created to sc-public-v3-webhooks-return_created
  • Documentation link corrected from /api/v3x/webhooks/return-created to /api/v3/webhooks/return-created

​

Changed endpoints:

• Changes for POST IntegrationConnected webhook:
  • Operation ID updated from sc-public-v2-webhooks-integration_connected to sc-public-v3-webhooks-integration_connected
• Changes for POST IntegrationDeleted webhook:
  • Operation ID updated from sc-public-v2-webhooks-integration_deleted to sc-public-v3-webhooks-integration_deleted
• Changes for POST IntegrationModified webhook:
  • Operation ID updated from sc-public-v2-webhooks-integration_modified to sc-public-v3-webhooks-integration_modified
• Changes for POST ParcelStatusChanged webhook:
  • Operation ID updated from sc-public-v2-webhooks-parcel_status_changed to sc-public-v3-webhooks-parcel_status_changed
• Changes for POST ReturnCreated webhook:
  • Operation ID updated from sc-public-v2-webhooks-return_created to sc-public-v3-webhooks-return_created
  • Documentation link corrected from /api/v3x/webhooks/return-created to /api/v3/webhooks/return-created

​

Changed endpoints:

• Changes for POST /pickups and related FedEx pickup endpoints:
  • Schema fedex-origin-detail: Field company_close_time example updated to include UTC timezone suffix (17:00:00Z)

​

Changed endpoints:

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

​

Changed endpoints:

• Changes for POST /api/v3/orders/{order_id}/shipments/label:
  • Request body schema changed:
    • Field shipping_option_code description updated to clarify it is mandatory when ship_with.type is set to shipping_option_code
• Changes for POST /api/v3/shipments/{shipment_id}/label:
  • Request body schema changed:
    • Field shipping_option_code description updated to clarify it is mandatory when ship_with.type is set to shipping_option_code

​

Added endpoints:

• POST /event-subscriptions/connections – Create a connection
• GET /event-subscriptions/connections – List connections
• GET /event-subscriptions/connections/{id} – Get a connection
• PATCH /event-subscriptions/connections/{id} – Update a connection
• DELETE /event-subscriptions/connections/{id} – Delete a connection
• GET /event-subscriptions/connections/type/{connection_type} – List connections by type
• POST /event-subscriptions/connections/{id}/authorization – Start OAuth2 authorization
• GET /event-subscriptions/connections/authorization/callback – OAuth2 callback
• POST /event-subscriptions/subscriptions – Create a subscription
• GET /event-subscriptions/subscriptions – List subscriptions
• GET /event-subscriptions/subscriptions/{id} – Get a subscription
• PATCH /event-subscriptions/subscriptions/{id} – Update a subscription
• DELETE /event-subscriptions/subscriptions/{id} – Delete a subscription
• GET /event-subscriptions/subscriptions/event/{event_type} – List subscriptions by event type
• POST /event-subscriptions/broadcast/test/{subscription_id} – Test event delivery

​

Changed endpoints:

• Changes for POST /address-washer:
  • Request body application/json changed:
    • Field validation_methods added to address-washer-request schema

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Beta notice updated with more detailed information about endpoint stability and guidance for integration reviews

​

Changed endpoints:

• Changes for GET /shipping-options:
  • Response schema shipping-quote changed:
    • Field estimated_surcharges added to quote object. This field contains an array of estimated surcharges that may be applied to the quote, presented separately from the base price as they are only estimates.

​

Changed endpoints:

• Changes for GET /shipping-options:
  • Response schema shipping-quote changed:
    • Field estimated_surcharges added (array of surcharge objects with price, label, and type properties)

​

Changed endpoints:

• Changes for GET /integrations/logs:
  • Parameter cursor example changed from '2023-03-01T02:02:00' to '2023-03-01T02:02:00+01:00'
• Changes for GET /integrations/{id}/logs:
  • Parameter cursor example changed from '2023-03-01T02:02:00' to '2023-03-01T02:02:00+01:00'

​

Changed schemas:

• base-pickup-request:
  • Field quantity added (type: integer, minimum: 1)
  • Field total_weight added (type: str-weight)
  • Required fields changed from time_slot, parcel_quantity to time_slots, quantity
• dhl-parcel-gb-pickup-request:
  • Required field parcel_quantity changed to quantity
• fedex-request:
  • Required fields changed from time_slot, parcel_quantity to time_slots, quantity
• ups-pickup-request:
  • Required field time_slot changed to time_slots
• IntegrationWebhookBase:
  • Field action added (type: string)

​

Changed endpoints:

• Changes for POST /oauth2/token:
  • Request body schema changed:
    • Field grant_type moved from property-level to object-level required fields

​

Changed endpoints:

• Changes for POST /shipments:
  • Request schema changed:
    • Schema service-point renamed to service-point-request
    • Field to_service_point now uses anyOf instead of oneOf
    • Description updated to clarify carrier_service_point_id takes priority when both id and carrier_service_point_id are provided
• Changes for POST /shipping-options/quote:
  • Request schema shipping-option-filter changed:
    • Field to_service_point_id deprecated: “Use to_service_point instead”
    • Field to_service_point added with reference to service-point-request schema
  • Request examples added:
    • New example ServicePointDelivery showing service point delivery with Sendcloud ID
    • New example ServicePointDeliveryWithCarrierId showing service point delivery with carrier ID

​

Added schemas:

• Schema service-point-request added to Shipping Options API:
  • Supports identification by either id (Sendcloud ID) or carrier_service_point_id (carrier’s ID)
  • Description clarifies priority when both fields are provided

​

Changed endpoints:

• Changes for POST /api/v3/dsf/forms/{form_type}/support-request (CreateAddressChangeTransactional schema):
  • Request body required field changed:
    • Field is_parcel_returned removed
    • Field new_address added

​

Changed endpoints:

• Changes for POST /parcels/tracking:
  • Endpoint marked as Beta
  • Documentation updated with detailed description and beta notice
  • Field tracking_number added to request schema
  • Field carrier added to request schema
  • Field sender address fields added to request schema
  • Field recipient address fields added to request schema
  • Optional fields parcel_items, measurements, and insurance added to request schema

​

Added endpoints:

• GET /integrations/logs - Retrieve all integration exception logs
• GET /integrations/{id}/logs - Retrieve exception logs for a specific integration
• POST /integrations/{id}/logs - Create integration exception logs

​

Changed endpoints:

• Changes for DELETE /integrations/{id}:
  • Response 404 / application/json changed:
    • Error response field status changed from string to integer type
    • Error response field title changed from “Not found” to “Not Found”
• Changes for PATCH /integrations/{id}:
  • Response 404 / application/json changed:
    • Error response field status changed from string to integer type
    • Error response field title changed from “Not found” to “Not Found”
• Changes for GET /integrations/{id}:
  • Response 404 / application/json changed:
    • Error response field status changed from string to integer type
    • Error response field title changed from “Not found” to “Not Found”

​

Added schemas:

• integration-log - Integration exception log object with fields: id, integration_id, base_url, full_url, method, response_code, response, request, created_at, exception_type, exception, protected, additional_data
• integration-log-create - Request body schema for creating integration exception logs

​

Changed endpoints:

• Changes for GET /contracts:
  • Description updated to include cursor-based pagination information
• Changes for GET /pickups:
  • Description updated to include cursor-based pagination information
• Changes for GET /addresses/sender-addresses:
  • Description updated to include cursor-based pagination information
• Changes for GET /shipments:
  • Description updated to include cursor-based pagination information
  • Response 200 / application/json header Link:
    • Description updated to standardize pagination link format (RFC8288)
    • Example added showing cursor-based pagination format

​

Changed endpoints:

• Changes for GET /api/v3/shipments:
  • Query parameter ids description updated: now clarifies this filters by parcels IDs
  • Query parameter shipment_uuids added: filter results using a comma-separated list of shipments IDs (max 100 IDs)

​

Changed endpoints:

• Changes for POST /api/v3/orders:
  • Request body schema changed:
    • Field service_point_details now supports two identification methods:
      • Sendcloud id (existing)
      • Carrier’s native carrier_service_point_id (new)
    • Field carrier_service_point_id added to service point schema
  • Response 201 / application/json changed:
    • Field service_point_details now supports two identification methods:
      • Sendcloud id (existing)
      • Carrier’s native carrier_service_point_id (new)
    • Field carrier_service_point_id added to service point schema
• Changes for PATCH /api/v3/orders/{id}:
  • Request body schema changed:
    • Field service_point_details now supports two identification methods:
      • Sendcloud id (existing)
      • Carrier’s native carrier_service_point_id (new)
    • Field carrier_service_point_id added to service point schema
  • Response 200 / application/json changed:
    • Field service_point_details now supports two identification methods:
      • Sendcloud id (existing)
      • Carrier’s native carrier_service_point_id (new)
    • Field carrier_service_point_id added to service point schema

​

Changed endpoints:

• Changes for POST /dsf/tickets/damage:
  • Query parameter is_portal_claim added
• Changes for POST /dsf/tickets/delay:
  • Query parameter is_portal_claim added
• Changes for POST /dsf/tickets/late-delivery:
  • Query parameter is_portal_claim added
• Changes for POST /dsf/tickets/lost:
  • Query parameter is_portal_claim added
• Changes for POST /dsf/tickets/delivered-but-not-received:
  • Query parameter is_portal_claim added
• Changes for POST /dsf/tickets/unjust-return:
  • Query parameter is_portal_claim added
• Changes for POST /dsf/tickets/address-change:
  • Query parameter is_portal_claim added

​

Schema changes:

• CreateDamagedOwnContract: Field carrier_contract_id added
• CreateDelayedOwnContract: Field carrier_contract_id added
• CreateLateDeliveryOwnContract: Field carrier_contract_id added
• CreateLostOwnContract: Field carrier_contract_id added
• CreateDeliveredButNotReceivedOwnContract: Field carrier_contract_id added
• CreateUnjustReturnOwnContract: Field carrier_contract_id added
• CreateAddressChangeOwnContract: Field carrier_contract_id added
• New schema CarrierContractIdField added

​

Changed endpoints:

• Changes for GET /checkout/configurations/{configuration_id}/delivery-options:
  • Documentation metadata updated with Beta tag

​

Changed endpoints:

• Changes for POST /carriers/dp/finalize-order:
  • Description updated: Removed “Required Permission: manage_shipping” note

​

Changed endpoints:

• Changes for POST /carriers/dp/finalize-order:
  • Description updated with detailed workflow and behavior documentation
  • Response 400 description changed to clarify copy_count parameter validation requirements
  • Response 200 example success_without_awb summary changed to “No eligible parcels found”
  • Field awb_document_url description updated to clarify behavior when no eligible parcels are found and that the AWB document is shared across all parcels in the box
  • Field next_order_id description updated to clarify behavior when parcels are successfully finalized versus when no eligible parcels are found

​

Added endpoints:

• POST /carriers/dp/finalize-order

​

Added endpoints:

• POST /dsf/tickets/late-delivery

​

Deprecated endpoints:

• POST /dsf/tickets/delay

​

Changed endpoints:

• Changes for POST /dsf/tickets/delay:
  • Endpoint marked as deprecated with migration guidance to use late delivery endpoint instead
• Changes for POST /dsf/tickets/late-delivery:
  • New schema CreateLateDeliveryOwnContract added with properties:
    • Field tracking_number (required)
    • Field additional_remarks (optional)

​

Added endpoints:

• POST /addresses/validate

​

Added schemas:

• raw-address - Raw address object with address line, house number, postal code, city, state/province code, and country code
• address-washer-request - Request object for address validation containing address and carrier code
• address-washer-response - Response object for address validation containing results with address, recommendation status, and validation analysis

​

Changed endpoints:

• Changes for POST /api/v3/contracts:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for GET /api/v3/contracts:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for GET /api/v3/checkout/configurations/{configuration_id}/delivery-options:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for GET /api/v3/orders:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for POST /api/v3/orders:
  • Field unit_price description updated: documentation reference changed from “Sendcloud platform” to “Sendcloud Panel”
  • Field total_price description updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel”
• Changes for GET /parcels/statuses:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for GET /api/v3/parcel-tracking/{tracking_number}:
  • Field brand_id description updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel”
• Changes for POST /api/v3/shipments:
  • Field sender_address_id description updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel”
  • Field brand_id description updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel”
  • Field to_service_point moved from shipment-common-with-optional-fields to shipment-request
  • Field validation_methods removed from shipment-common-with-optional-fields
  • Schema service-point changed: now supports both Sendcloud ID and carrier service point ID via oneOf
  • Schema service-point-response added to responses with both id and carrier_service_point_id fields
• Changes for POST /api/v3/shipments/async:
  • Field to_service_point moved and schema updated to support both Sendcloud ID and carrier service point ID
  • Field validation_methods removed
  • Documentation updated regarding shipping rules: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for GET /api/v3/shipments/{id}/cancel:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
• Changes for Webhooks:
  • Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”

​

Changed endpoints:

• Changes for POST /shipments/announce-with-shipping-rules:
  • Description updated: Removed beta status notice and breaking changes warning
• Changes for POST /shipments/create-with-shipping-rules:
  • Description updated: Removed beta status notice and breaking changes warning

​

Changed endpoints:

• Changes for POST /shipments/announce_with_rules:
  • Documentation updated:
    • Removed “Set customs export reason” from available shipping rules actions
    • Removed “Set customs export type” from available shipping rules actions
• Changes for POST /shipments/create_with_rules:
  • Documentation updated:
    • Removed “Set customs export reason” from available shipping rules actions
    • Removed “Set customs export type” from available shipping rules actions

​

Changed endpoints:

• Changes for POST /orders:
  • Request body schema updated:
    • Field id added to order creation requests (optional, must be sent as string)
  • Response 400 / application/json changed:
    • Error response documentation expanded with detailed error examples and JSON Pointer notation explanation
    • New error examples added: MissingRequiredField, InvalidFieldValue, DuplicateOrderProcessing, BatchSizeLimitExceeded, MultipleValidationErrors, IntegrationNotFound, ImmutableFieldChange, InvalidIdType
  • Endpoint documentation expanded with comprehensive upsert behavior, batch processing details, limitations, and best practices
• Changes for POST /shipments:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
• Changes for GET /shipments:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
• Changes for PATCH /shipments/{id}:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
• Changes for GET /shipments/{id}:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
• Changes for POST /shipments/announce-with-shipping-rules:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
  • Documentation updated with note on carrier-specific parcel limits
• Changes for POST /shipments/create-with-shipping-rules:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
• Changes for POST /parcels:
  • Field dds_reference added to parcel items (optional)
  • Field taric_doc_code added to parcel items (optional)
  • Field dangerous_goods added to parcel items (optional)
  • Field tracking_identifier added to tracking numbers (optional)
  • ship_with schema restructured: Now supports discriminated union with two types: shipping_option_code and contract
  • Field user_shipping_method_name added to ship_with properties (optional)
  • Field user_shipping_method_id added to ship_with properties (optional)
  • Field contract_id made required for shipping_option_code type
• Changes for POST /ship-orders:
  • Field renamed: order_items changed to parcel_items in multicollo parcel definitions
• Changes for POST /returns:
  • Field return_fee added to return response (optional)
• Changes for GET /returns:
  • Field return_fee added to return response (optional)
• Changes for GET /returns/{id}:
  • Field return_fee added to return response (optional)

​

Removed endpoints:

• PUT /api/v3/orders/{id}

​

Added endpoints:

• GET /api/v3/dsf/forms/categories
• GET /api/v3/dsf/forms/{form_type}/fields
• POST /api/v3/dsf/forms/{form_type}/support-request
• POST /api/v3/support/dsf/forms/fileupload

​

Changed endpoints:

• Changes for POST /api/v3/shop-order-statuses/mapping/:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for GET /api/v3/shop-order-statuses/mapping/:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for POST /api/v3/shop-order-statuses:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for GET /api/v3/shop-order-statuses:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for GET /api/v3/integrations/{id}:
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for PATCH /api/v3/integrations/{id}:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for DELETE /api/v3/integrations/{id}:
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for PATCH /api/v3/orders/{id}:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for DELETE /api/v3/orders/{id}:
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for PUT /api/v3/orders/{id}:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for GET /api/v3/orders/{id}:
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for GET /api/v3/orders:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas
• Changes for POST /api/v3/orders:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas

​

Added endpoints:

• DELETE /api/v3/integrations/{id}
• PATCH /api/v3/integrations/{id}
• GET /api/v3/integrations/{id}
• GET /api/v3/integrations
• GET /api/v3/shop-order-statuses
• POST /api/v3/shop-order-statuses
• GET /api/v3/shop-order-statuses/mapping/
• POST /api/v3/shop-order-statuses/mapping/

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field data added
    • Field id removed
    • Field order_id removed
    • Field order_number removed
• Changes for PUT /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field data added
    • Field id removed
    • Field order_id removed
    • Field order_number removed
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field data added
    • Field order_id removed
    • Field order_number removed
    • Field order_details removed
    • Field payment_details removed
    • Field id removed
    • Field created_at removed
    • Field modified_at removed
    • Field customs_details removed
    • Field customer_details removed
    • Field billing_address removed
    • Field shipping_address removed
    • Field shipping_details removed
    • Field service_point_details removed

​

Changed endpoints:

• Changes for POST /api/v3/returns/validate:
  • Parameters changed:
    • Request body param customs_information added
• Changes for GET /api/v3/returns/{id}:
  • Response 200 / application/json changed:
    • Field customs_information added
• Changes for GET /api/v3/returns:
  • Response 200 / application/json changed:
    • Field data.items.customs_information added
• Changes for POST /api/v3/returns:
  • Parameters changed:
    • Request body param customs_information added

​

Changed endpoints:

• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param shipping_details.is_local_pickup added
    • Request body param payment_details.is_cash_on_delivery added
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field shipping_details.is_local_pickup added
    • Field payment_details.is_cash_on_delivery added
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Field items.shipping_details.is_local_pickup added
    • Field items.payment_details.is_cash_on_delivery added
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.shipping_details.is_local_pickup added
    • Request body param items.payment_details.is_cash_on_delivery added

​

Added endpoints:

• POST /oauth2/token

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param payment_details.invoice_date added
• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param payment_details.invoice_date added
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field payment_details.invoice_date added
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Field items.payment_details.invoice_date added
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.payment_details.invoice_date added

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param tax_numbers added
    • Request body param payment_details.discount_granted added
    • Request body param payment_details.insurance_costs added
    • Request body param payment_details.freight_costs added
    • Request body param payment_details.other_costs added
    • Request body param order_details.order_items.items.mid_code added
    • Request body param order_details.order_items.items.material_content added
    • Request body param order_details.order_items.items.intended_use added

​

Changed endpoints:

• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param payment_details.discount_granted added
    • Request body param payment_details.insurance_costs added
    • Request body param payment_details.freight_costs added
    • Request body param payment_details.other_costs added
    • Request body param order_details.order_items.items.mid_code added
    • Request body param order_details.order_items.items.material_content added
    • Request body param order_details.order_items.items.intended_use added
    • Request body param customs_details now can be null
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field payment_details.discount_granted added
    • Field payment_details.insurance_costs added
    • Field payment_details.freight_costs added
    • Field payment_details.other_costs added
    • Field order_details.order_items.items.mid_code added
    • Field order_details.order_items.items.material_content added
    • Field order_details.order_items.items.intended_use added
    • Field customs_details now can be null
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Field items.payment_details.discount_granted added
    • Field items.payment_details.insurance_costs added
    • Field items.payment_details.freight_costs added
    • Field items.payment_details.other_costs added
    • Field items.order_details.order_items.items.mid_code added
    • Field items.order_details.order_items.items.material_content added
    • Field items.order_details.order_items.items.intended_use added
    • Field items.customs_details now can be null
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.payment_details.discount_granted added
    • Request body param items.payment_details.insurance_costs added
    • Request body param items.payment_details.freight_costs added
    • Request body param items.payment_details.other_costs added
    • Request body param items.order_details.order_items.items.mid_code added
    • Request body param items.order_details.order_items.items.material_content added
    • Request body param items.order_details.order_items.items.intended_use added
    • Request body param items.customs_details now can be null

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 401 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
• Changes for DELETE /api/v3/orders/{id}:
  • Response 401 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
• Changes for PUT /api/v3/orders/{id}:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 401 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
• Changes for GET /api/v3/orders/{id}:
  • Response 401 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
• Changes for GET /api/v3/orders:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 401 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 404 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
• Changes for POST /api/v3/orders:
  • Response 400 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']
  • Response 401 / application/json changed:
    • Polymorphism object:
      • errors.allOf changed supported schemas, ['Error'] added
    • Field errors changed its type to ['array', 'object']

​

Changed endpoints:

• Changes for GET /api/v3/returns/{id}:
  • Response 200 / application/json changed:
    • Field status_history.items.carrier_update_timestamp has new format: date-time
• Changes for GET /api/v3/returns:
  • Response 200 / application/json changed:
    • Field data.items.status_history.items.carrier_update_timestamp has new format: date-time

​

Changed endpoints:

• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param shipping_details.delivery_indicator added
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field shipping_details.delivery_indicator added
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Field items.shipping_details.delivery_indicator added
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.shipping_details.delivery_indicator added

​

Added endpoints:

• POST /api/v3/returns/validate
• GET /api/v3/returns/{id}
• POST /api/v3/returns
• GET /api/v3/returns

​

Changed endpoints:

• Changes for GET /api/v3/orders:
  • Parameters changed:
    • Query param sort added

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Response 400 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 401 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 404 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
• Changes for DELETE /api/v3/orders/{id}:
  • Response 401 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 404 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
• Changes for PUT /api/v3/orders/{id}:
  • Response 400 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 401 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 404 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
• Changes for GET /api/v3/orders/{id}:
  • Response 401 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 404 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
• Changes for GET /api/v3/orders:
  • Response 400 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 401 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 404 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
• Changes for POST /api/v3/orders:
  • Response 400 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed
  • Response 401 / application/json changed:
    • Field errors.status removed
    • Field errors.code removed
    • Field errors.detail removed

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param shipping_address.po_box now can be null
    • Request body param shipping_address.po_box is not nullable anymore
    • Request body param billing_address.po_box now can be null
    • Request body param billing_address.po_box is not nullable anymore
    • Request body param order_details.order_items.items.delivery_dates now can be null
    • Request body param order_details.order_items.items.delivery_dates is not nullable anymore
• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param shipping_address.oneOf.0.po_box now can be null
    • Request body param shipping_address.oneOf.0.po_box is not nullable anymore
    • Request body param billing_address.oneOf.0.po_box now can be null
    • Request body param billing_address.oneOf.0.po_box is not nullable anymore
    • Request body param order_details.order_items.items.delivery_dates now can be null
    • Request body param order_details.order_items.items.delivery_dates is not nullable anymore
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field shipping_address.oneOf.0.po_box now can be null
    • Field shipping_address.oneOf.0.po_box is not nullable anymore
    • Field billing_address.oneOf.0.po_box now can be null
    • Field billing_address.oneOf.0.po_box is not nullable anymore
    • Field order_details.order_items.items.delivery_dates now can be null
    • Field order_details.order_items.items.delivery_dates is not nullable anymore
• Changes for GET /api/v3/orders:
  • Parameters changed:
    • Query param order_id added
  • Response 200 / application/json changed:
    • Field items.shipping_address.oneOf.0.po_box now can be null
    • Field items.shipping_address.oneOf.0.po_box is not nullable anymore
    • Field items.billing_address.oneOf.0.po_box now can be null
    • Field items.billing_address.oneOf.0.po_box is not nullable anymore
    • Field items.order_details.order_items.items.delivery_dates now can be null
    • Field items.order_details.order_items.items.delivery_dates is not nullable anymore
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.shipping_address.oneOf.0.po_box now can be null
    • Request body param items.shipping_address.oneOf.0.po_box is not nullable anymore
    • Request body param items.billing_address.oneOf.0.po_box now can be null
    • Request body param items.billing_address.oneOf.0.po_box is not nullable anymore
    • Request body param items.order_details.order_items.items.delivery_dates now can be null
    • Request body param items.order_details.order_items.items.delivery_dates is not nullable anymore

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Parameters changed:
    • Polymorphism object:
      • shipping_address.oneOf changed supported schemas, ['Address Object'] removed
      • billing_address.oneOf changed supported schemas, ['Address Object'] removed
    • Request body param shipping_address changed its type to object
    • Request body param billing_address changed its type to object
• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Polymorphism object:
      • payment_details.estimated_tax_price.oneOf changed supported schemas, ['Price Object'] added
      • payment_details.estimated_shipping_price.oneOf changed supported schemas, ['Price Object'] added
      • payment_details.subtotal_price.oneOf changed supported schemas, ['Price Object'] added
      • payment_details.total_price.oneOf changed supported schemas, ['Price Object'] added
    • Request body param order_details.status.code has new minimal length restriction: 1
    • Request body param order_id has new minimal length restriction: 1
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • payment_details.estimated_tax_price.oneOf changed supported schemas, ['Price Object'] added
      • payment_details.estimated_shipping_price.oneOf changed supported schemas, ['Price Object'] added
      • payment_details.subtotal_price.oneOf changed supported schemas, ['Price Object'] added
      • payment_details.total_price.oneOf changed supported schemas, ['Price Object'] added
    • Field order_details.status.code has new minimal length restriction: 1
    • Field order_id has new minimal length restriction: 1
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • items.payment_details.estimated_tax_price.oneOf changed supported schemas, ['Price Object'] added
      • items.payment_details.estimated_shipping_price.oneOf changed supported schemas, ['Price Object'] added
      • items.payment_details.subtotal_price.oneOf changed supported schemas, ['Price Object'] added
      • items.payment_details.total_price.oneOf changed supported schemas, ['Price Object'] added
    • Field items.order_details.status.code has new minimal length restriction: 1
    • Field items.order_id has new minimal length restriction: 1
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Polymorphism object:
      • items.payment_details.estimated_tax_price.oneOf changed supported schemas, ['Price Object'] added
      • items.payment_details.estimated_shipping_price.oneOf changed supported schemas, ['Price Object'] added
      • items.payment_details.subtotal_price.oneOf changed supported schemas, ['Price Object'] added
      • items.payment_details.total_price.oneOf changed supported schemas, ['Price Object'] added
    • Request body param items.order_details.status.code has new minimal length restriction: 1
    • Request body param items.order_id has new minimal length restriction: 1

​

Changed endpoints:

• Changes for GET /api/v3/orders:
  • Parameters changed:
    • Query param order_number added
    • Query param status added
    • Query param order_created_at added
    • Query param order_created_at_min added
    • Query param order_created_at_max added
    • Query param order_updated_at added
    • Query param order_updated_at_min added
    • Query param order_updated_at_max added

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param order_details.order_items.items.delivery_dates added
• Changes for PUT /api/v3/orders/{id}:
  • Parameters changed:
    • Request body param order_details.order_items.items.delivery_dates added
• Changes for GET /api/v3/orders/{id}:
  • Response 200 / application/json changed:
    • Field order_details.order_items.items.delivery_dates added
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Field items.order_details.order_items.items.delivery_dates added
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.order_details.order_items.items.delivery_dates added

​

Added endpoints:

• GET /api/v3/orders/{id}
• PUT /api/v3/orders/{id}
• DELETE /api/v3/orders/{id}
• PATCH /api/v3/orders/{id}

​

Removed endpoints:

• GET /api/v3/orders/{id}/
• PUT /api/v3/orders/{id}/
• DELETE /api/v3/orders/{id}/
• PATCH /api/v3/orders/{id}/

​

Changed endpoints:

• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Field items.shipping_details.shipping_method removed
    • Field items.order_details.shipping_functionalities removed
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.shipping_details.shipping_method removed
    • Request body param items.order_details.shipping_functionalities removed

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}/:
  • Parameters changed:
    • Request body param id is read only now
• Changes for PUT /api/v3/orders/{id}/:
  • Parameters changed:
    • Request body param id is read only now
• Changes for GET /api/v3/orders/{id}/:
  • Response 200 / application/json changed:
    • Field id is read only now
• Changes for GET /api/v3/orders:
  • Parameters changed:
    • Path param Link removed
  • Response 200 / application/json changed:
    • Field items.id is read only now
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Request body param items.id is read only now