Changelog

This page contains the changelog of the current API version. For the past changelog, please refer to this page.

2025-01 (2025-01-09)

1. General

CHANGE	BEFORE	AFTER
Base URL	https://api.aftership.com/commerce/2024-10	https://api.aftership.com/commerce/2025-01

2. Order Resource Changes

2.1 Updated Fields

order.items.*.id

BEFORE	AFTER
order.items.*.source_id	order.items.*.id

Affected Endpoints (Request and Response Body)

• POST /orders (request_body.items.*.id)

Affected Endpoints (Response Body)

• GET /orders
• GET /orders/{id}
• PATCH /orders/{id}

2.2 Removed Fields

order.items.*.fulfillable_quantity

BEFORE	AFTER
order.items.*.fulfillable_quantity	Field deleted

Affected Endpoints (Request and Response Body)

• POST /orders

Affected Endpoints (Response Body)

• GET /orders
• GET /orders/{id}
• PATCH /orders/{id}

2.3 Required Fields Changes

FIELD	BEFORE	AFTER
order.items.*.product_title	Field value is optional	Field value is now required
order.items.*.product_variant_title	Field value is required	Field value is now optional

Affected Endpoints (Request Body)

• POST /orders

3. Order Endpoints Changes

3.1 Update an order by ID (PATCH /orders/{id})

Request Body

The following fields are added to the request body to provide more control to the endpoint. The specification of each of the fields are the same as the model.

• currency
• order_total
• shipping_total
• tax_total
• discount_total
• subtotal

4. Product Resource Changes

4.1 Required Fields Changes

FIELD	BEFORE	AFTER
title	Field value is required	Field value is optional

Affected Endpoints (Request body)

• POST /products

5. Fulfillment Resource Changes

5.1 Updated Fields

fulfillment.line_items.*.id

BEFORE	AFTER
fulfillment.line_items.*.source_id	fulfillment.line_items.*.id

Affected Endpoints (Request and Response Body)

• POST /fulfillments (request_body.line_items.*.id)

Affected Endpoints (Response Body)

• GET /fulfillments
• GET /fulfillments/{id}
• PATCH /fulfillments/{id}
• POST /fulfillments/{id}/update-status
• POST /fulfillments/{id}/ship

6. New API Endpoints

New endpoints for manipulating order.items (OrderItem resource) are added. As the OrderItem resource is a subresource of Order, order.id is required during the request, which would be specified in the URL.

For the detailed endpoint specification, please refer to the API endpoint reference.

1. Create an order item (POST /orders/{id}/items)
   • Create a new order item to an existing order.
2. Get order item by ID (GET /orders/{id}/items/{item_id})
   • Get an existing order item by order ID and order item ID.
3. Update order item by ID (PATCH /orders/{id}/items/{item_id})
   • Update an existing order item by order ID and order item ID.
4. Delete order item by ID (DELETE /orders/{id}/items/{item_id})
   • Delete an existing order item by order ID and order item ID.