One of unshipped, shipped, or cancelled. The current status of the shipment.
tracking_number
string
If available, the shipment's tracking number.
sub_cycle
int
The shipment's sequence number in a subscription. E.g. 1 for the first shipment in a subscription, 2 for the second shipment, etc.
Note: Ecom orders have a nullsub_cycle
adjusted_ordered_at
datetime
The date used to determine when a shipment should ship for ecom shipments or shipments in ad hoc subscriptions
Available for subscription products that have a standard billing type (e.g. all subs renew on the 15th). Read more here.
cust_cycle
int
The shipment's sequence number for a customer across all orders and subscriptions. E.g. 1 for the first shipment for a customer, 2 for the second shipment, etc.
Ship Address Data Object
Each shipment will have a shipping address attached.
Field
Type
Description
phone_number
string
If available, the phone number for the recipient.
to
string
Name of the recipient. Note that for gift purchases, this will be the gift recipient's name, if the purchaser shipped the gift directly to the gift recipient.
state
string
city
string
country
string
company
string
id
int
The unique ID for this shipping address.
unit
string
zip_code
string
Fulfillment Data Object
Each shipment contains at least 1 fulfillment. A fulfillment represents a single product_instance line item in a shipment. Each fulfillment will have associated with it a product_instance and an order.
Field
Type
Description
fulfillment_date
datetime
The target fulfillment date.
subscription_id
int
If the fulfillment is part of a subscription, the subscription ID.
The product instance associated with the fulfillment. Read more here.
Batch Data Object
Subscription products that have a standard billing_type (e.g. all subscriptions renew on the 15th, regardless of when they were purchased) have shipping batch associated with the shipment. For more on batches and how they can help you figure out what to ship and when, read more here.
Field
Type
Description
start
datetime
Start date for the batch. Meaning, all orders for the same product placed after the start date and before the end date will be in this same batch.
end
datetime
End date for the batch. The target ship date for a product within a batch should be shipped sometime soon after the batch's end date.
Whether the order was purchased as a gift or not. If the order was a gift, the order will have an order_gift_info data object as well. Read more about that here.
is_renewal
bool
Whether this order was a subscription renewal order or not.
customer
resource
Information about the customer who purchased the order. Read more here.
subscriptions
resource
Information about the subscription associated with this order, if the order has a subscription associated with it. Read more here.
order_gift_info
resource
Information about the gift and message, if the order was a gift. Read more here.
Product Instance Data Object
Underneath each product instance will also be a product
Field
Type
Description
sku
string
SKU for the product instance; note that if the product has variants, this is the SKU for the unique combination of variants.
gift
bool
For Cratejoy sellers on the legacy Gifting 1.0 product, this will tell you if the purchase was a gift purchase. Will always be false for sellers on the updated Gifting 3.0+ feature.
price
int
For ecom products, price of the product in the smallest unit of currency for the store's currency. E.g. 100 in USD is $1.00.
ship_weight
int
The product's ship weight.
id
int
Unique ID for the product_instance
product
resource
Information about the product associated with the product instance. Read more here.
variants
resource
Information about the variants options for this product_instance, if the product has variants. Read more here.
Customer Data Object
Underneath each order, you'll find information about the customer who purchased the order.
Field
Type
Description
id
int
Unique customer ID associated with the person who purchased the order.
name
string
Name of the customer who purchased the order. Note that if the order is a gift, this is the name of the gift buyer.
email
string
Email address of the customer who purchased the order. Note that if the order is a gift, this is the email address of the gift buyer.
Subscription Data Object
Underneath each order, you'll find information about the customer. If the subscription has product survey results, they will also be contained here as a sub resource
Field
Type
Description
status
string
The subscription's current status. One of active, expired, cancelled, past_due.
id
int
The unique ID associated with the subscription.
start_date
datetime
The start date for the subscription -- the date of the first order for the subscription.
term_id
int
The current subscription type term id of the subscription.
Order Gift Info Data Object
If the order is a gift, this will contain the gift message associated with the order.
Field
Type
Description
gift_message
string
If available, the gift message left by the purchaser for the gift recipient.
id
int
Unique ID for the order gift data object.
Subscription Product Survey Results
If a subscription's subscribe flow contains a customer survey, you'll find the results of that survey here.
Field
Type
Description
survey_name
string
Name of the survey
id
int
Unique ID for the survey
answers.answer
string
For each question in a survey, the answer given by the purchaser.
answers.type
string
The format of the answer given, e.g. multiple_choice
answers.question
string
The question asked in the customer survey.
Product Data Object
Field
Type
Description
sku
string
SKU for the product
id
int
Unique ID for the product
name
string
Name of the product.
Product Variant Data Object
For each variant type and value, you'll find the following underneath instance.variants
Field
Type
Description
type
string
The type of variant. E.g. "Size"
id
int
Unique ID for this variant answer.
value
string
The value selected for the variant. E.g. "Medium" or "Small"
