Shipment data object

Properties

Property Filter Edit Type Description
id INT Unique identifier
adjusted_ordered_at DATETIME The target ship date. See important note below about what this actually means.
created_at DATETIME Date the shipment was created
is_ecom BOOLEAN Whether it's a non-subscription shipment or a subscription shipment.
is_test BOOLEAN Whether it's a test shipment (created in test mode)
shipped_at DATETIME When it was marked shipped.
status STRING one of "unshipped" (1), "shipped" (2), or "cancelled" (3)
target_at DATETIME The target ship date. [Deprecated]
tracking_number STRING The tracking number of the package
type STRING
url STRING Direct link to GET the full details of the customer

Default Related Properties

PropertyResourceDescription
customerCustomerA customer object
fulfillmentsFulfillmentA list of Fulfillments
labelsShippingLabelA list of ShippingLabels
ship_addressCustomerAddressWhere the package is being shipped can be updated using the CustomerAddress endpoint

bold - may be used to filter collections

Additional Related Properties

see Working with Object Relationships

PropertyResourceDescription
_mdShipment Metadata
batchShipment BatchThe batch the shipment belongs to
label_batchThe label printing batch for bulk printing
subscriptionsSubscriptionThe subscriptions attached to the shipment.
statsShipment StatsAdditional details about the shipment—cycle counts, etc.

The above properties are references to another Cratejoy resource or another collection of Cratejoy resources.

The properties can either be a url to fetch the related resources OR contain the resources themselves

Target ship date and "adjusted_ordered_at"

With ecommerce (non-subscriotion) products, as well as subscription products using ad hoc billing, the "adjusted_ordered_at" is the target ship date. With other subscription products, shipments are lumped into batches and the actual ship date is sometime following the end of the batch date range.

If your product has a renewal date of the 15th with a 14-day cutoff window, you batches will be:
A. January 1 - January 31
B. February 1 - February 28 (or 29)
C. March 1 - March 30
E. etc.

Any shipment with an adjustedordered_at anywhere from January 1 to January 31 will be in the "A" batch and should be shipped in early February. Thus, moving such a shipment's adjusted_ordered_at from 2016-01-01 to 2016-01-20 _wouldn't change when it ships. It's still shipped early February.

However, changing adjustedordered_at from 2016-01-30 to 2016-02-01 _would move it from batch A (shipping early February) to batch B (which ships early March).