v1.015

v1.015

Adds update-behavior documentation to order and item fields that are silently ignored when syncing an existing order. No schema or endpoint changes β€” descriptions only.


πŸš€ New Endpoints

None

πŸ“– Documentation & Constraints Changes

Create or Update Order β€” order-level fields

The following fields on POST /v1/integrations/order now document their update behavior explicitly:

  • order_number (string) β€” description updated to clarify that this field cannot be changed after the order is created. Sending a different value on subsequent syncs is silently ignored.
  • customer_notes (string|null) β€” description updated to clarify that this field can only be set once. If the order already has a value for this field, any new value is ignored on update.
  • internal_notes (string|null) β€” description updated to clarify that this field can only be set once. It is always ignored when updating an existing order.
  • gift_message (string|null) β€” description updated to clarify that this field can only be set once. If the order already has a gift message, any new value is ignored on update.

Create or Update Order β€” item-level fields

The following item fields on POST /v1/integrations/order now document that they are immutable after the item is first created. Sending different values on subsequent syncs is silently ignored:

  • name (string) β€” product name cannot be changed after the item is created.
  • price (number) β€” unit price cannot be changed after the item is created.
  • image_url (string|null) β€” product image URL cannot be changed after the item is created.
  • custom_data (object) β€” custom data key-value pairs cannot be changed after the item is created.
  • b2b_attributes (array<string>) β€” B2B attributes cannot be changed after the item is created.
  • lot_requirements (object) β€” Cannot be changed when order is submitted.

Create or Update Order β€” special requirements

  • pack_list_required (boolean) β€” description updated to clarify that this field is ignored when updating an existing order. It can only be set at order creation time.