API v3 Changelog

​

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 for POST /store-locations:
  • Added x-mint documentation metadata including href, Beta tag, and descriptive content
• Changes for GET /store-locations:
  • Added x-mint documentation metadata including href and Beta tag
• Changes for GET /store-locations/{id}:
  • Added x-mint documentation metadata including href, Beta tag, and usage notes
• Changes for PATCH /store-locations/{id}:
  • Added x-mint documentation metadata including href, Beta tag, and partial update behavior note
• Changes for DELETE /store-locations/{id}:
  • Added x-mint documentation metadata including href, Beta tag, and soft-delete behavior notes

​

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

​

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 /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 /store-locations:
  • Documentation metadata updated
• Changes for GET /store-locations:
  • Documentation metadata updated
• Changes for GET /store-locations/{id}:
  • Documentation metadata updated
• Changes for PATCH /store-locations/{id}:
  • Documentation metadata updated
• Changes for DELETE /store-locations/{id}:
  • Documentation metadata updated

​

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

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}/:
  • Parameters changed:
    • Polymorphism object:
      • shipping_address.oneOf changed supported schemas, ['Address Object'] added
      • billing_address.oneOf changed supported schemas, ['Address Object'] added
• Changes for PUT /api/v3/orders/{id}/:
  • Parameters changed:
    • Polymorphism object:
      • shipping_address.oneOf changed supported schemas, ['Address Object'] added
      • billing_address.oneOf changed supported schemas, ['Address Object'] added
• Changes for GET /api/v3/orders/{id}/:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • shipping_address.oneOf changed supported schemas, ['Address Object'] added
      • billing_address.oneOf changed supported schemas, ['Address Object'] added
• Changes for GET /api/v3/orders:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • items.shipping_address.oneOf changed supported schemas, ['Address Object'] added
      • items.billing_address.oneOf changed supported schemas, ['Address Object'] added
• Changes for POST /api/v3/orders:
  • Parameters changed:
    • Polymorphism object:
      • items.shipping_address.oneOf changed supported schemas, ['Address Object'] added
      • items.billing_address.oneOf changed supported schemas, ['Address Object'] added

​

Changed endpoints:

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

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}/:
  • Response 200 / application/json changed:
    • Field created_at removed
    • Field modified_at removed
• Changes for PUT /api/v3/orders/{id}/:
  • Response 200 / application/json changed:
    • Field created_at removed
    • Field modified_at removed

​

Added endpoints:

• POST /api/v3/orders
• GET /api/v3/orders

​

Removed endpoints:

• POST /api/v3/orders/
• GET /api/v3/orders/
• POST /api/v3/orders/{id}/split/

​

Changed endpoints:

• Changes for PATCH /api/v3/orders/{id}/:
  • Parameters changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 400 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
  • Response 401 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
    • Field errors changed its type to object
  • Response 404 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
• Changes for DELETE /api/v3/orders/{id}/:
  • Response 401 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
    • Field errors changed its type to object
  • Response 404 / text/html; charset=utf-8 changed:
    • Field root removed
  • Response 404 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
• Changes for PUT /api/v3/orders/{id}/:
  • Parameters changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
    • Request body param order_id added
    • Request body param order_number added
    • Request body param order_details added
    • Request body param payment_details added
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 400 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
  • Response 401 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
    • Field errors changed its type to object
  • Response 404 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
• Changes for GET /api/v3/orders/{id}/:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
    • Field order_id added
    • Field order_number added
    • Field order_details added
    • Field payment_details added
  • Response 401 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added
    • Field errors changed its type to object
  • Response 404 / text/html; charset=utf-8 changed:
    • Field root removed
  • Response 404 / application/json changed:
    • Field errors.status added
    • Field errors.code added
    • Field errors.detail added

​

Changed endpoints:

• Changes for POST /api/v3/orders/{id}/split/:
  • Parameters changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 201 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
• Changes for PATCH /api/v3/orders/{id}/:
  • Parameters changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
• Changes for PUT /api/v3/orders/{id}/:
  • Parameters changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
• Changes for GET /api/v3/orders/{id}/:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
• Changes for GET /api/v3/orders/:
  • Response 200 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
• Changes for POST /api/v3/orders/:
  • Parameters changed:
    • Polymorphism object:
      • root.allOf changed supported schemas
  • Response 201 / application/json changed:
    • Polymorphism object:
      • root.allOf changed supported schemas