This is the documentation for 2022-02-01.

Changelog

The changelog is a list of backwards-incompatible updates in the API. As described before, new additions and forwards-compatible changes don’t need a new API version and will not appear in this list.

2022-01-01

Removed webhook events

  • The webhook event shipping-rate.calculated was removed
  • The webhook event id-tag.updated was removed

Renamed webhook events

  • The webhook event logo.ready was renamed to logo.completed
  • The webhook event order.ready was renamed to order.prepared
  • The webhook event order.shipped was renamed to order.completed
  • The webhook event variant.designed was renamed to variant.completed
  • The webhook event fulfillment.ready was renamed to shipment.prepared

Removed endpoints

Some media endpoints were removed

  • The end point GET {{ endpoint }}/media was removed
  • The end point GET {{ endpoint }}/media/{{ YOUR_MEDIA_ID }}/download was removed

All checkout endpoints were removed

  • The end point POST {{ endpoint }}/checkouts was removed
  • The end point GET {{ endpoint }}/checkouts/{{ YOUR_ORDER_ID }}/shipping-rates was removed
  • The end point PUT {{ endpoint }}/checkouts/{{ YOUR_ORDER_ID }} was removed
  • The end point PUT {{ endpoint }}/checkouts/{{ YOUR_ORDER_ID }}/complete was removed

All custom variant endpoints were removed

  • The end point GET {{ endpoint }}/custom-variants was removed
  • The end point GET {{ endpoint }}/custom-variants/{{ YOUR_CUSTOM_VARIANT_ID }} was removed

Added endpoints

Production methods endpoint

  • Endpoint GET {{ endpoint }}/production-methods has been added, for more information see page production-methods.

Logos endpoints

  • Endpoint GET {{ endpoint }}/logos has been added, for more information see page logos.
  • Endpoint GET {{ endpoint }}/logos/{{ YOUR_LOGO_ID }} has been added, for more information see page logos.
  • Endpoint POST {{ endpoint }}/logos has been added, for more information see page logos.
  • Endpoint POST {{ endpoint }}/logos/{{ YOUR_LOGO_ID }}/design has been added, for more information see page logos.

Shipping methods endpoint

  • Endpoint GET {{ endpoint }}/shipping-methods has been added, for more information see page shipping-methods.

Orders endpoint

  • Endpoint POST {{ endpoint }}/orders has been added, for more information see page orders.

2021-02-23

  • The fulfillments object has now all parcels objects. See in the endpoint orders.
  • The fulfillments.order_id was changed to an order object. See in the endpoint orders.

2020-01-17

  • The project_name parameter has changed to external_reference in the endpoint checkouts.
  • The project_name in the order resource within the endpoints checkouts and orders has changed to external_reference.

2019-10-01

2019-02-28

  • include parameter is replaced by the expand parameter.
  • On the products endpoint the variant resource initially only shows ids. You have to use ?expand=variants to show the complete resource
  • Removed current_state in id_tags

2018-12-06

  • The variant resource is not automatically loaded on the products endpoint. You have to you use ?include=variants
  • Pagination simplified.
    • Removed meta.last_page and meta.total attribute.
    • links.last will always be null.
  • shipping_line attribute removed in orders endpoint and added a shipping_total attribute
  • Added state and order_id to id_tags

2017-09-25

  • Initial Release