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 typeparcels.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_typeadded (enum:webhook,klaviyo) — filter connections by type
- Query parameter
-
Changes for GET
/event-subscriptions/subscriptions:- Query parameter
event_typeadded — filter subscriptions by event type - Query parameter
is_activeadded — filter subscriptions by active status
- Query parameter
Changed endpoints:
- Changes for POST
/api/v3/shipments(sync) and POST/api/v3/shipments(async):- Field
goods_descriptionadded tocustoms_informationrequest body and response (optional string, max 255 characters; used for customs clearance purposes — note: not supported by all carriers) - Field
general_notesincustoms_informationno longer has a minimum length requirement
- Field
Changed endpoints:
-
Changes for POST
/api/v3/shipments/announce(announce shipment with rules):- Response
201now includes fieldapplied_shipping_rules— a list of shipping rules that were applied to the shipment, each containing the ruleid, rulename, and aresultobject describing the modifications made
- Response
-
Changes for POST
/api/v3/shipments(create shipment with rules):- Response
201now includes fieldapplied_shipping_rules— a list of shipping rules that were applied to the shipment, each containing the ruleid, rulename, and aresultobject describing the modifications made
- Response
Changed endpoints:
- Changes for POST
/shipping-options:- Field
messageadded to response200/application/json
- Field
Changed endpoints:
-
Changes for POST
/api/v3/support/provide-requested-data:- Field
request_iddescription updated with reference to the GET endpoint for retrieval - Field
commentdescription clarified as optional - Field
attachmentsdescription updated with links to file upload and document generation endpoints - Field
attachments[].file_tokendescription updated to reference the file upload endpoint - Field
sales_datadescription clarified as required whendata_typeissales_data - Field
forceadded (boolean, defaultfalse): bypasses the maximum invoice amount validation of 5000 EUR - Response
404now returnsrequest_id not founddetail instead of genericNot found - Documentation updated: clarified that
commentfield is not required for providing data contents - Example updated to include
force: truefor sales data requests
- Field
-
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/jsonchanged:- Field
carrieradded to shipment response object (containscodeandnamesubfields)
- Field
- Response
-
Changes for POST
/shipments(async):- Response
201/application/jsonchanged:- Field
carrieradded to shipment response object (containscodeandnamesubfields)
- Field
- Response
-
Changes for POST
/shipments(with rules):- Response
201/application/jsonchanged:- Field
carrieradded to shipment response object (containscodeandnamesubfields)
- Field
- Response
-
Changes for
base-shipment-responseschema:- Field
carrieradded: a read-only object containing carriercode(Sendcloud unique identifier) andname(friendly name)
- Field
Changed endpoints:
- Changes for
last_milefield in shipping product/method properties (Returns API and Shipping Options API):- Enum value
poboxremoved fromlast_milefield - Enum value
lockeradded tolast_milefield (shipment delivered to a locker) - Enum value
locker_or_service_pointadded tolast_milefield (shipment delivered to a locker or a service point) - Fixed typo in
MAILBOXdescription:recepient→recipient
- Enum value
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
429now references endpoint-specific rate limit response (30 requests per minute)
-
Changes for GET
/api/v3/dsf/carrier-support-contacts:- Response
429added
- Response
-
Changes for PATCH
/api/v3/dsf/carrier-support-contacts/{id}:- Response
429added
- Response
-
Changes for DELETE
/api/v3/dsf/carrier-support-contacts/{id}:- Response
429added
- Response
-
Changes for POST
/api/v3/dsf/tickets/damage:- Response
429now references endpoint-specific rate limit response (15 requests per minute)
- Response
-
Changes for POST
/api/v3/dsf/tickets/delay:deprecated: trueflag removed- Description updated: endpoint now explicitly scoped to Sendcloud rates parcels only
- Request body no longer accepts own contract parcel schema (
CreateDelayedOwnContract); onlyCreateDelayedTransactionalis accepted - Schema
CreateDelayedOwnContractremoved - Response
429now references endpoint-specific rate limit response (15 requests per minute)
-
Changes for POST
/api/v3/dsf/tickets/late-delivery:- Response
429now references endpoint-specific rate limit response (15 requests per minute)
- Response
-
Changes for POST
/api/v3/dsf/tickets/lost:- Response
429now references endpoint-specific rate limit response (15 requests per minute)
- Response
-
Changes for POST
/api/v3/dsf/tickets/delivered-but-not-received:- Response
429now references endpoint-specific rate limit response (15 requests per minute)
- Response
-
Changes for POST
/api/v3/dsf/tickets/unjust-return:- Response
429now references endpoint-specific rate limit response (15 requests per minute)
- Response
-
Changes for POST
/api/v3/dsf/tickets/address-change:- Response
429now references endpoint-specific rate limit response (15 requests per minute)
- Response
-
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_typeenum values reduced to:claim_letter,sales_invoice,sales_data,purchase_invoice,description_of_contents- Response
429added
- Path corrected to
-
Changes for POST
/api/v3/dsf/tickets/requested-data:- Endpoint summary updated to “Create a requested data response”
- Accepted
data_typevalues for file attachments reduced to:sales_invoice,purchase_invoice,claim_letter - Accepted
data_typevalues for textual input reduced to:description_of_contents - Field
selling_pricedescription updated: value must now be tax-included - Response
429added
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_optionadded toReturnresponse object label_urlexample URLs updated from v2 Labels API (/api/v2/labels/...) to v3 Parcel Documents API (/api/v3/parcels/{id}/documents/label)label.label_printerexample URL updated to v3 Parcel Documents APIlabel.normal_printerexample URLs updated to v3 Parcel Documents API; description updated to clarify the array always contains 4 identical URLs for backward compatibility
- Field
- Changes for GET
/returnsand GET/returns/{id}(Return schema):- Field
shipping_optionadded (object with nullablecodestring referencing the shipping option code) label_urlexample updated to v3 Parcel Documents API URL formatlabel.label_printerexample updated to v3 Parcel Documents API URL formatlabel.normal_printerdescription and examples updated to v3 Parcel Documents API URL formatshipping_optionadded to required fields
- Field
Changed endpoints:
-
Changes for GET
/support/dsf/tickets/requested-data:- Added
pagequery parameter (integer, default: 1) - Added
sizequery parameter (integer, default: 50, maximum: 100) - Response
200schema changed:- Field
dataremoved from required properties and replaced withitems - Field
totaladded (integer, total number of items across all pages) - Field
pageadded (integer, current page number) - Field
pagesadded (integer, total number of pages) - Field
sizeadded (integer, number of items per page) - Field
itemsadded (array, replacesdataarray) - Field
descriptionremoved from individual item objects
- Field
- Added
-
Changes for POST
/support/dsf/tickets/requested-data:- Response
400now referencesProvideRequestedDataBadRequestinstead ofBadRequestResponse, adding more specific error examples: validation errors, action not allowed, and sales data required
- Response
Changed endpoints:
- Changes for POST
IntegrationConnectedwebhook:- Operation ID updated from
sc-public-v2-webhooks-integration_connectedtosc-public-v3-webhooks-integration_connected
- Operation ID updated from
- Changes for POST
IntegrationDeletedwebhook:- Operation ID updated from
sc-public-v2-webhooks-integration_deletedtosc-public-v3-webhooks-integration_deleted
- Operation ID updated from
- Changes for POST
IntegrationModifiedwebhook:- Operation ID updated from
sc-public-v2-webhooks-integration_modifiedtosc-public-v3-webhooks-integration_modified
- Operation ID updated from
- Changes for POST
ParcelStatusChangedwebhook:- Operation ID updated from
sc-public-v2-webhooks-parcel_status_changedtosc-public-v3-webhooks-parcel_status_changed
- Operation ID updated from
- Changes for POST
ReturnCreatedwebhook:- Operation ID updated from
sc-public-v2-webhooks-return_createdtosc-public-v3-webhooks-return_created - Documentation link corrected from
/api/v3x/webhooks/return-createdto/api/v3/webhooks/return-created
- Operation ID updated from
Changed endpoints:
- Changes for POST
IntegrationConnectedwebhook:- Operation ID updated from
sc-public-v2-webhooks-integration_connectedtosc-public-v3-webhooks-integration_connected
- Operation ID updated from
- Changes for POST
IntegrationDeletedwebhook:- Operation ID updated from
sc-public-v2-webhooks-integration_deletedtosc-public-v3-webhooks-integration_deleted
- Operation ID updated from
- Changes for POST
IntegrationModifiedwebhook:- Operation ID updated from
sc-public-v2-webhooks-integration_modifiedtosc-public-v3-webhooks-integration_modified
- Operation ID updated from
- Changes for POST
ParcelStatusChangedwebhook:- Operation ID updated from
sc-public-v2-webhooks-parcel_status_changedtosc-public-v3-webhooks-parcel_status_changed
- Operation ID updated from
- Changes for POST
ReturnCreatedwebhook:- Operation ID updated from
sc-public-v2-webhooks-return_createdtosc-public-v3-webhooks-return_created - Documentation link corrected from
/api/v3x/webhooks/return-createdto/api/v3/webhooks/return-created
- Operation ID updated from
Changed endpoints:
- Changes for POST
/pickupsand related FedEx pickup endpoints:- Schema
fedex-origin-detail: Fieldcompany_close_timeexample updated to include UTC timezone suffix (17:00:00Z)
- Schema
Changed endpoints:
- Changes for POST
/store-locations:- Added
x-mintdocumentation metadata including href, Beta tag, and descriptive content
- Added
- Changes for GET
/store-locations:- Added
x-mintdocumentation metadata including href and Beta tag
- Added
- Changes for GET
/store-locations/{id}:- Added
x-mintdocumentation metadata including href, Beta tag, and usage notes
- Added
- Changes for PATCH
/store-locations/{id}:- Added
x-mintdocumentation metadata including href, Beta tag, and partial update behavior note
- Added
- Changes for DELETE
/store-locations/{id}:- Added
x-mintdocumentation metadata including href, Beta tag, and soft-delete behavior notes
- Added
Changed endpoints:
- Changes to
IntegrationWebhookBaseschema:- Field
integration.failing_sinceexample updated to include UTC timezone suffix (2019-02-03T06:48:07Z) - Field
integration.last_fetchexample updated to include UTC timezone suffix (2019-02-03T06:48:07Z) - Field
integration.last_updated_atexample updated to include UTC timezone suffix (2019-02-03T06:48:07Z)
- Field
Changed endpoints:
-
Changes for POST
/api/v3/orders/{order_id}/shipments/label:- Request body schema changed:
- Field
shipping_option_codedescription updated to clarify it is mandatory whenship_with.typeis set toshipping_option_code
- Field
- Request body schema changed:
-
Changes for POST
/api/v3/shipments/{shipment_id}/label:- Request body schema changed:
- Field
shipping_option_codedescription updated to clarify it is mandatory whenship_with.typeis set toshipping_option_code
- Field
- Request body schema changed:
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/jsonchanged:- Field
validation_methodsadded toaddress-washer-requestschema
- Field
- Request body
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-quotechanged:- Field
estimated_surchargesadded 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.
- Field
- Response schema
Changed endpoints:
- Changes for GET
/shipping-options:- Response schema
shipping-quotechanged:- Field
estimated_surchargesadded (array of surcharge objects withprice,label, andtypeproperties)
- Field
- Response schema
Changed endpoints:
-
Changes for GET
/integrations/logs:- Parameter
cursorexample changed from'2023-03-01T02:02:00'to'2023-03-01T02:02:00+01:00'
- Parameter
-
Changes for GET
/integrations/{id}/logs:- Parameter
cursorexample changed from'2023-03-01T02:02:00'to'2023-03-01T02:02:00+01:00'
- Parameter
Changed schemas:
-
base-pickup-request:- Field
quantityadded (type: integer, minimum: 1) - Field
total_weightadded (type: str-weight) - Required fields changed from
time_slot,parcel_quantitytotime_slots,quantity
- Field
-
dhl-parcel-gb-pickup-request:- Required field
parcel_quantitychanged toquantity
- Required field
-
fedex-request:- Required fields changed from
time_slot,parcel_quantitytotime_slots,quantity
- Required fields changed from
-
ups-pickup-request:- Required field
time_slotchanged totime_slots
- Required field
-
IntegrationWebhookBase:- Field
actionadded (type: string)
- Field
Changed endpoints:
- Changes for POST
/oauth2/token:- Request body schema changed:
- Field
grant_typemoved from property-level to object-level required fields
- Field
- Request body schema changed:
Changed endpoints:
-
Changes for POST
/shipments:- Request schema changed:
- Schema
service-pointrenamed toservice-point-request - Field
to_service_pointnow usesanyOfinstead ofoneOf - Description updated to clarify
carrier_service_point_idtakes priority when bothidandcarrier_service_point_idare provided
- Schema
- Request schema changed:
-
Changes for POST
/shipping-options/quote:- Request schema
shipping-option-filterchanged:- Field
to_service_point_iddeprecated: “Useto_service_pointinstead” - Field
to_service_pointadded with reference toservice-point-requestschema
- Field
- Request examples added:
- New example
ServicePointDeliveryshowing service point delivery with Sendcloud ID - New example
ServicePointDeliveryWithCarrierIdshowing service point delivery with carrier ID
- New example
- Request schema
Added schemas:
- Schema
service-point-requestadded to Shipping Options API:- Supports identification by either
id(Sendcloud ID) orcarrier_service_point_id(carrier’s ID) - Description clarifies priority when both fields are provided
- Supports identification by either
Changed endpoints:
- Changes for POST
/api/v3/dsf/forms/{form_type}/support-request(CreateAddressChangeTransactional schema):- Request body required field changed:
- Field
is_parcel_returnedremoved - Field
new_addressadded
- Field
- Request body required field changed:
Changed endpoints:
- Changes for POST
/parcels/tracking:- Endpoint marked as Beta
- Documentation updated with detailed description and beta notice
- Field
tracking_numberadded to request schema - Field
carrieradded to request schema - Field
senderaddress fields added to request schema - Field
recipientaddress fields added to request schema - Optional fields
parcel_items,measurements, andinsuranceadded 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/jsonchanged:- Error response field
statuschanged from string to integer type - Error response field
titlechanged from “Not found” to “Not Found”
- Error response field
- Response
-
Changes for PATCH
/integrations/{id}:- Response
404/application/jsonchanged:- Error response field
statuschanged from string to integer type - Error response field
titlechanged from “Not found” to “Not Found”
- Error response field
- Response
-
Changes for GET
/integrations/{id}:- Response
404/application/jsonchanged:- Error response field
statuschanged from string to integer type - Error response field
titlechanged from “Not found” to “Not Found”
- Error response field
- Response
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_dataintegration-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/jsonheaderLink:- 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
idsdescription updated: now clarifies this filters by parcels IDs - Query parameter
shipment_uuidsadded: filter results using a comma-separated list of shipments IDs (max 100 IDs)
- Query parameter
Changed endpoints:
-
Changes for POST
/api/v3/orders:- Request body schema changed:
- Field
service_point_detailsnow supports two identification methods:- Sendcloud
id(existing) - Carrier’s native
carrier_service_point_id(new)
- Sendcloud
- Field
carrier_service_point_idadded to service point schema
- Field
- Response
201/application/jsonchanged:- Field
service_point_detailsnow supports two identification methods:- Sendcloud
id(existing) - Carrier’s native
carrier_service_point_id(new)
- Sendcloud
- Field
carrier_service_point_idadded to service point schema
- Field
- Request body schema changed:
-
Changes for PATCH
/api/v3/orders/{id}:- Request body schema changed:
- Field
service_point_detailsnow supports two identification methods:- Sendcloud
id(existing) - Carrier’s native
carrier_service_point_id(new)
- Sendcloud
- Field
carrier_service_point_idadded to service point schema
- Field
- Response
200/application/jsonchanged:- Field
service_point_detailsnow supports two identification methods:- Sendcloud
id(existing) - Carrier’s native
carrier_service_point_id(new)
- Sendcloud
- Field
carrier_service_point_idadded to service point schema
- Field
- Request body schema changed:
Changed endpoints:
- Changes for POST
/dsf/tickets/damage:- Query parameter
is_portal_claimadded
- Query parameter
- Changes for POST
/dsf/tickets/delay:- Query parameter
is_portal_claimadded
- Query parameter
- Changes for POST
/dsf/tickets/late-delivery:- Query parameter
is_portal_claimadded
- Query parameter
- Changes for POST
/dsf/tickets/lost:- Query parameter
is_portal_claimadded
- Query parameter
- Changes for POST
/dsf/tickets/delivered-but-not-received:- Query parameter
is_portal_claimadded
- Query parameter
- Changes for POST
/dsf/tickets/unjust-return:- Query parameter
is_portal_claimadded
- Query parameter
- Changes for POST
/dsf/tickets/address-change:- Query parameter
is_portal_claimadded
- Query parameter
Schema changes:
CreateDamagedOwnContract: Fieldcarrier_contract_idaddedCreateDelayedOwnContract: Fieldcarrier_contract_idaddedCreateLateDeliveryOwnContract: Fieldcarrier_contract_idaddedCreateLostOwnContract: Fieldcarrier_contract_idaddedCreateDeliveredButNotReceivedOwnContract: Fieldcarrier_contract_idaddedCreateUnjustReturnOwnContract: Fieldcarrier_contract_idaddedCreateAddressChangeOwnContract: Fieldcarrier_contract_idadded- New schema
CarrierContractIdFieldadded
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
400description changed to clarifycopy_countparameter validation requirements - Response
200examplesuccess_without_awbsummary changed to “No eligible parcels found” - Field
awb_document_urldescription 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_iddescription updated to clarify behavior when parcels are successfully finalized versus when no eligible parcels are found
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
CreateLateDeliveryOwnContractadded with properties:- Field
tracking_number(required) - Field
additional_remarks(optional)
- Field
- New schema
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 codeaddress-washer-request- Request object for address validation containing address and carrier codeaddress-washer-response- Response object for address validation containing results with address, recommendation status, and validation analysis
2026-01-29
Contracts APIDynamic Checkout APIOrders APIParcel Statuses APIParcel Tracking APIShipments APIWebhooks API
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_pricedescription updated: documentation reference changed from “Sendcloud platform” to “Sendcloud Panel” - Field
total_pricedescription updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel”
- Field
- Changes for GET
/parcels/statuses:- Documentation updated: “Sendcloud platform” changed to “Sendcloud panel”
- Changes for GET
/api/v3/parcel-tracking/{tracking_number}:- Field
brand_iddescription updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel”
- Field
- Changes for POST
/api/v3/shipments:- Field
sender_address_iddescription updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel” - Field
brand_iddescription updated: documentation reference changed from “Sendcloud platform” to “Sendcloud panel” - Field
to_service_pointmoved fromshipment-common-with-optional-fieldstoshipment-request - Field
validation_methodsremoved fromshipment-common-with-optional-fields - Schema
service-pointchanged: now supports both Sendcloud ID and carrier service point ID viaoneOf - Schema
service-point-responseadded to responses with bothidandcarrier_service_point_idfields
- Field
- Changes for POST
/api/v3/shipments/async:- Field
to_service_pointmoved and schema updated to support both Sendcloud ID and carrier service point ID - Field
validation_methodsremoved - Documentation updated regarding shipping rules: “Sendcloud platform” changed to “Sendcloud panel”
- Field
- 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
- Documentation updated:
-
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
- Documentation updated:
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
idadded to order creation requests (optional, must be sent as string)
- Field
- Response
400/application/jsonchanged:- 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
- Request body schema updated:
-
Changes for POST
/shipments:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional)
- Field
-
Changes for GET
/shipments:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional)
- Field
-
Changes for PATCH
/shipments/{id}:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional)
- Field
-
Changes for GET
/shipments/{id}:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional)
- Field
-
Changes for POST
/shipments/announce-with-shipping-rules:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional) - Documentation updated with note on carrier-specific parcel limits
- Field
-
Changes for POST
/shipments/create-with-shipping-rules:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional)
- Field
-
Changes for POST
/parcels:- Field
dds_referenceadded to parcel items (optional) - Field
taric_doc_codeadded to parcel items (optional) - Field
dangerous_goodsadded to parcel items (optional) - Field
tracking_identifieradded to tracking numbers (optional) ship_withschema restructured: Now supports discriminated union with two types:shipping_option_codeandcontract- Field
user_shipping_method_nameadded to ship_with properties (optional) - Field
user_shipping_method_idadded to ship_with properties (optional) - Field
contract_idmade required forshipping_option_codetype
- Field
-
Changes for POST
/ship-orders:- Field renamed:
order_itemschanged toparcel_itemsin multicollo parcel definitions
- Field renamed:
-
Changes for POST
/returns:- Field
return_feeadded to return response (optional)
- Field
-
Changes for GET
/returns:- Field
return_feeadded to return response (optional)
- Field
-
Changes for GET
/returns/{id}:- Field
return_feeadded to return response (optional)
- Field
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/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for GET
/api/v3/shop-order-statuses/mapping/:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for POST
/api/v3/shop-order-statuses:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for GET
/api/v3/shop-order-statuses:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for GET
/api/v3/integrations/{id}:- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for PATCH
/api/v3/integrations/{id}:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for DELETE
/api/v3/integrations/{id}:- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for PATCH
/api/v3/orders/{id}:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for DELETE
/api/v3/orders/{id}:- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for PUT
/api/v3/orders/{id}:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders/{id}:- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for POST
/api/v3/orders:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas
- Polymorphism object:
- Response
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/jsonchanged:- Field
dataadded - Field
idremoved - Field
order_idremoved - Field
order_numberremoved
- Field
- Response
- Changes for PUT
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
dataadded - Field
idremoved - Field
order_idremoved - Field
order_numberremoved
- Field
- Response
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
dataadded - Field
order_idremoved - Field
order_numberremoved - Field
order_detailsremoved - Field
payment_detailsremoved - Field
idremoved - Field
created_atremoved - Field
modified_atremoved - Field
customs_detailsremoved - Field
customer_detailsremoved - Field
billing_addressremoved - Field
shipping_addressremoved - Field
shipping_detailsremoved - Field
service_point_detailsremoved
- Field
- Response
Changed endpoints:
- Changes for POST
/api/v3/returns/validate:- Parameters changed:
- Request body param
customs_informationadded
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/returns/{id}:- Response
200/application/jsonchanged:- Field
customs_informationadded
- Field
- Response
- Changes for GET
/api/v3/returns:- Response
200/application/jsonchanged:- Field
data.items.customs_informationadded
- Field
- Response
- Changes for POST
/api/v3/returns:- Parameters changed:
- Request body param
customs_informationadded
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Request body param
shipping_details.is_local_pickupadded - Request body param
payment_details.is_cash_on_deliveryadded
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
shipping_details.is_local_pickupadded - Field
payment_details.is_cash_on_deliveryadded
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Field
items.shipping_details.is_local_pickupadded - Field
items.payment_details.is_cash_on_deliveryadded
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.shipping_details.is_local_pickupadded - Request body param
items.payment_details.is_cash_on_deliveryadded
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Parameters changed:
- Request body param
payment_details.invoice_dateadded
- Request body param
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Request body param
payment_details.invoice_dateadded
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
payment_details.invoice_dateadded
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Field
items.payment_details.invoice_dateadded
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.payment_details.invoice_dateadded
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Parameters changed:
- Request body param
tax_numbersadded - Request body param
payment_details.discount_grantedadded - Request body param
payment_details.insurance_costsadded - Request body param
payment_details.freight_costsadded - Request body param
payment_details.other_costsadded - Request body param
order_details.order_items.items.mid_codeadded - Request body param
order_details.order_items.items.material_contentadded - Request body param
order_details.order_items.items.intended_useadded
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Request body param
payment_details.discount_grantedadded - Request body param
payment_details.insurance_costsadded - Request body param
payment_details.freight_costsadded - Request body param
payment_details.other_costsadded - Request body param
order_details.order_items.items.mid_codeadded - Request body param
order_details.order_items.items.material_contentadded - Request body param
order_details.order_items.items.intended_useadded - Request body param
customs_detailsnow can be null
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
payment_details.discount_grantedadded - Field
payment_details.insurance_costsadded - Field
payment_details.freight_costsadded - Field
payment_details.other_costsadded - Field
order_details.order_items.items.mid_codeadded - Field
order_details.order_items.items.material_contentadded - Field
order_details.order_items.items.intended_useadded - Field
customs_detailsnow can be null
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Field
items.payment_details.discount_grantedadded - Field
items.payment_details.insurance_costsadded - Field
items.payment_details.freight_costsadded - Field
items.payment_details.other_costsadded - Field
items.order_details.order_items.items.mid_codeadded - Field
items.order_details.order_items.items.material_contentadded - Field
items.order_details.order_items.items.intended_useadded - Field
items.customs_detailsnow can be null
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.payment_details.discount_grantedadded - Request body param
items.payment_details.insurance_costsadded - Request body param
items.payment_details.freight_costsadded - Request body param
items.payment_details.other_costsadded - Request body param
items.order_details.order_items.items.mid_codeadded - Request body param
items.order_details.order_items.items.material_contentadded - Request body param
items.order_details.order_items.items.intended_useadded - Request body param
items.customs_detailsnow can be null
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
401/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
- Changes for DELETE
/api/v3/orders/{id}:- Response
401/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
- Changes for PUT
/api/v3/orders/{id}:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
401/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders/{id}:- Response
401/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
401/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
404/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
- Changes for POST
/api/v3/orders:- Response
400/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
401/application/jsonchanged:- Polymorphism object:
errors.allOfchanged supported schemas,['Error']added
- Field
errorschanged its type to['array', 'object']
- Polymorphism object:
- Response
Changed endpoints:
- Changes for GET
/api/v3/returns/{id}:- Response
200/application/jsonchanged:- Field
status_history.items.carrier_update_timestamphas new format:date-time
- Field
- Response
- Changes for GET
/api/v3/returns:- Response
200/application/jsonchanged:- Field
data.items.status_history.items.carrier_update_timestamphas new format:date-time
- Field
- Response
Changed endpoints:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Request body param
shipping_details.delivery_indicatoradded
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
shipping_details.delivery_indicatoradded
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Field
items.shipping_details.delivery_indicatoradded
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.shipping_details.delivery_indicatoradded
- Request body param
- Parameters changed:
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
sortadded
- Query param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Response
400/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
401/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
- Changes for DELETE
/api/v3/orders/{id}:- Response
401/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
- Changes for PUT
/api/v3/orders/{id}:- Response
400/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
401/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
- Changes for GET
/api/v3/orders/{id}:- Response
401/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
400/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
401/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
- Changes for POST
/api/v3/orders:- Response
400/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
401/application/jsonchanged:- Field
errors.statusremoved - Field
errors.coderemoved - Field
errors.detailremoved
- Field
- Response
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Parameters changed:
- Request body param
shipping_address.po_boxnow can be null - Request body param
shipping_address.po_boxis not nullable anymore - Request body param
billing_address.po_boxnow can be null - Request body param
billing_address.po_boxis not nullable anymore - Request body param
order_details.order_items.items.delivery_datesnow can be null - Request body param
order_details.order_items.items.delivery_datesis not nullable anymore
- Request body param
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Request body param
shipping_address.oneOf.0.po_boxnow can be null - Request body param
shipping_address.oneOf.0.po_boxis not nullable anymore - Request body param
billing_address.oneOf.0.po_boxnow can be null - Request body param
billing_address.oneOf.0.po_boxis not nullable anymore - Request body param
order_details.order_items.items.delivery_datesnow can be null - Request body param
order_details.order_items.items.delivery_datesis not nullable anymore
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
shipping_address.oneOf.0.po_boxnow can be null - Field
shipping_address.oneOf.0.po_boxis not nullable anymore - Field
billing_address.oneOf.0.po_boxnow can be null - Field
billing_address.oneOf.0.po_boxis not nullable anymore - Field
order_details.order_items.items.delivery_datesnow can be null - Field
order_details.order_items.items.delivery_datesis not nullable anymore
- Field
- Response
- Changes for GET
/api/v3/orders:- Parameters changed:
- Query param
order_idadded
- Query param
- Response
200/application/jsonchanged:- Field
items.shipping_address.oneOf.0.po_boxnow can be null - Field
items.shipping_address.oneOf.0.po_boxis not nullable anymore - Field
items.billing_address.oneOf.0.po_boxnow can be null - Field
items.billing_address.oneOf.0.po_boxis not nullable anymore - Field
items.order_details.order_items.items.delivery_datesnow can be null - Field
items.order_details.order_items.items.delivery_datesis not nullable anymore
- Field
- Parameters changed:
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.shipping_address.oneOf.0.po_boxnow can be null - Request body param
items.shipping_address.oneOf.0.po_boxis not nullable anymore - Request body param
items.billing_address.oneOf.0.po_boxnow can be null - Request body param
items.billing_address.oneOf.0.po_boxis not nullable anymore - Request body param
items.order_details.order_items.items.delivery_datesnow can be null - Request body param
items.order_details.order_items.items.delivery_datesis not nullable anymore
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Parameters changed:
- Polymorphism object:
shipping_address.oneOfchanged supported schemas,['Address Object']removedbilling_address.oneOfchanged supported schemas,['Address Object']removed
- Request body param
shipping_addresschanged its type toobject - Request body param
billing_addresschanged its type toobject
- Polymorphism object:
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Polymorphism object:
payment_details.estimated_tax_price.oneOfchanged supported schemas,['Price Object']addedpayment_details.estimated_shipping_price.oneOfchanged supported schemas,['Price Object']addedpayment_details.subtotal_price.oneOfchanged supported schemas,['Price Object']addedpayment_details.total_price.oneOfchanged supported schemas,['Price Object']added
- Request body param
order_details.status.codehas new minimal length restriction:1 - Request body param
order_idhas new minimal length restriction:1
- Polymorphism object:
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Polymorphism object:
payment_details.estimated_tax_price.oneOfchanged supported schemas,['Price Object']addedpayment_details.estimated_shipping_price.oneOfchanged supported schemas,['Price Object']addedpayment_details.subtotal_price.oneOfchanged supported schemas,['Price Object']addedpayment_details.total_price.oneOfchanged supported schemas,['Price Object']added
- Field
order_details.status.codehas new minimal length restriction:1 - Field
order_idhas new minimal length restriction:1
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Polymorphism object:
items.payment_details.estimated_tax_price.oneOfchanged supported schemas,['Price Object']addeditems.payment_details.estimated_shipping_price.oneOfchanged supported schemas,['Price Object']addeditems.payment_details.subtotal_price.oneOfchanged supported schemas,['Price Object']addeditems.payment_details.total_price.oneOfchanged supported schemas,['Price Object']added
- Field
items.order_details.status.codehas new minimal length restriction:1 - Field
items.order_idhas new minimal length restriction:1
- Polymorphism object:
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Polymorphism object:
items.payment_details.estimated_tax_price.oneOfchanged supported schemas,['Price Object']addeditems.payment_details.estimated_shipping_price.oneOfchanged supported schemas,['Price Object']addeditems.payment_details.subtotal_price.oneOfchanged supported schemas,['Price Object']addeditems.payment_details.total_price.oneOfchanged supported schemas,['Price Object']added
- Request body param
items.order_details.status.codehas new minimal length restriction:1 - Request body param
items.order_idhas new minimal length restriction:1
- Polymorphism object:
- Parameters changed:
Changed endpoints:
- Changes for GET
/api/v3/orders:- Parameters changed:
- Query param
order_numberadded - Query param
statusadded - Query param
order_created_atadded - Query param
order_created_at_minadded - Query param
order_created_at_maxadded - Query param
order_updated_atadded - Query param
order_updated_at_minadded - Query param
order_updated_at_maxadded
- Query param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}:- Parameters changed:
- Request body param
order_details.order_items.items.delivery_datesadded
- Request body param
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}:- Parameters changed:
- Request body param
order_details.order_items.items.delivery_datesadded
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}:- Response
200/application/jsonchanged:- Field
order_details.order_items.items.delivery_datesadded
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Field
items.order_details.order_items.items.delivery_datesadded
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.order_details.order_items.items.delivery_datesadded
- Request body param
- Parameters changed:
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/jsonchanged:- Field
items.shipping_details.shipping_methodremoved - Field
items.order_details.shipping_functionalitiesremoved
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.shipping_details.shipping_methodremoved - Request body param
items.order_details.shipping_functionalitiesremoved
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}/:- Parameters changed:
- Request body param
idis read only now
- Request body param
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}/:- Parameters changed:
- Request body param
idis read only now
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Field
idis read only now
- Field
- Response
- Changes for GET
/api/v3/orders:- Parameters changed:
- Path param
Linkremoved
- Path param
- Response
200/application/jsonchanged:- Field
items.idis read only now
- Field
- Parameters changed:
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.idis read only now
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}/:- Parameters changed:
- Polymorphism object:
shipping_address.oneOfchanged supported schemas,['Address Object']addedbilling_address.oneOfchanged supported schemas,['Address Object']added
- Polymorphism object:
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}/:- Parameters changed:
- Polymorphism object:
shipping_address.oneOfchanged supported schemas,['Address Object']addedbilling_address.oneOfchanged supported schemas,['Address Object']added
- Polymorphism object:
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Polymorphism object:
shipping_address.oneOfchanged supported schemas,['Address Object']addedbilling_address.oneOfchanged supported schemas,['Address Object']added
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Polymorphism object:
items.shipping_address.oneOfchanged supported schemas,['Address Object']addeditems.billing_address.oneOfchanged supported schemas,['Address Object']added
- Polymorphism object:
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Polymorphism object:
items.shipping_address.oneOfchanged supported schemas,['Address Object']addeditems.billing_address.oneOfchanged supported schemas,['Address Object']added
- Polymorphism object:
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}/:- Parameters changed:
- Request body param
order_details.order_created_atadded - Request body param
order_details.order_updated_atadded - Request body param
order_details.order_dateremoved
- Request body param
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}/:- Parameters changed:
- Request body param
order_details.order_created_atadded - Request body param
order_details.order_updated_atadded - Request body param
order_details.order_dateremoved
- Request body param
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Field
order_details.order_created_atadded - Field
order_details.order_updated_atadded - Field
order_details.order_dateremoved
- Field
- Response
- Changes for GET
/api/v3/orders:- Response
200/application/jsonchanged:- Field
items.order_details.order_created_atadded - Field
items.order_details.order_updated_atadded - Field
items.order_details.order_dateremoved
- Field
- Response
- Changes for POST
/api/v3/orders:- Parameters changed:
- Request body param
items.order_details.order_created_atadded - Request body param
items.order_details.order_updated_atadded - Request body param
items.order_details.order_dateremoved
- Request body param
- Parameters changed:
Changed endpoints:
- Changes for PATCH
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Field
created_atremoved - Field
modified_atremoved
- Field
- Response
- Changes for PUT
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Field
created_atremoved - Field
modified_atremoved
- Field
- Response
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.allOfchanged supported schemas
- Polymorphism object:
- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
400/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded
- Field
- Response
401/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded - Field
errorschanged its type toobject
- Field
- Response
404/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded
- Field
- Parameters changed:
- Changes for DELETE
/api/v3/orders/{id}/:- Response
401/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded - Field
errorschanged its type toobject
- Field
- Response
404/text/html; charset=utf-8changed:- Field
rootremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded
- Field
- Response
- Changes for PUT
/api/v3/orders/{id}/:- Parameters changed:
- Polymorphism object:
root.allOfchanged supported schemas
- Request body param
order_idadded - Request body param
order_numberadded - Request body param
order_detailsadded - Request body param
payment_detailsadded
- Polymorphism object:
- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
400/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded
- Field
- Response
401/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded - Field
errorschanged its type toobject
- Field
- Response
404/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded
- Field
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Field
order_idadded - Field
order_numberadded - Field
order_detailsadded - Field
payment_detailsadded
- Polymorphism object:
- Response
401/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded - Field
errorschanged its type toobject
- Field
- Response
404/text/html; charset=utf-8changed:- Field
rootremoved
- Field
- Response
404/application/jsonchanged:- Field
errors.statusadded - Field
errors.codeadded - Field
errors.detailadded
- Field
- Response
Changed endpoints:
- Changes for POST
/api/v3/orders/{id}/split/:- Parameters changed:
- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
201/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Parameters changed:
- Changes for PATCH
/api/v3/orders/{id}/:- Parameters changed:
- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Parameters changed:
- Changes for PUT
/api/v3/orders/{id}/:- Parameters changed:
- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Parameters changed:
- Changes for GET
/api/v3/orders/{id}/:- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for GET
/api/v3/orders/:- Response
200/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
- Changes for POST
/api/v3/orders/:- Parameters changed:
- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Response
201/application/jsonchanged:- Polymorphism object:
root.allOfchanged supported schemas
- Polymorphism object:
- Parameters changed: