The Cratejoy Merchant API has a more streamlined shipment endpoint, GET https://api.cratejoy/v1.1/shipments specifically intended for Cratejoy fulfillment partners. It is a simpler and faster endpoint than the standard verbose shipment endpoint.. It's built to include only the most crucial information commonly used by Cratejoy fulfillment partners.
Summary of differences between v1.1/shipments/ and v1/shipments/
v1.1 is for GET requests only. To modify/update shipments, e.g. adding tracking numbers or marking them as shipped, please use PUT https://api.cratejoy/v1/shipments , documentation here.
v1.1 cannot return a given shipment by ID. You can return a given shipment by ID with v1, e.g. GET https://api.cratejoy/v1/shipments/{id}, but v1.1 can only return groups of shipments.
v1.1 returns less data about a given shipment data object. The verbose v1 endpoint returns far more information about the shipment (e.g. by default includes full customer data, shipping label information, and can include far more information about the subscription, its terms). The v1.1 endpoint is streamlined to include only the most crucial information commonly used by Cratejoy fulfillment partners. For more on what the verbose v1 shipment data object list contains, please check out the shipment data object information here.
v1.1 has limited filtering options compared to the v1 object. The verbose v1 endpoint has many filtering options on many resources on the shipment object. For more on what filtering options are available for the v1.1 endpoint, read more here.
Gift Message is in a different place. v1.1 has the gift_message for gift orders under fulfillments.order.order_gift_info.gift_message, not fulfillments.order.gift_message like v1 does.
v1.1 makes it easier to filter to include only shipments from standard subscriptions, ad hoc subscriptions, or ecom purchases. Previously, if you wanted to find all shipments from ad hoc subscriptions, you might have to filter on shipments based on null batch IDs + subscription ID, for example. We've introduced a new filter billing_type that makes it easy to filter on what type of shipment you're dealing with. Read more about that here.