Order data object specification for the Cratejoy Merchant API
Properties
Property | Filter | Edit | Type | Description |
---|---|---|---|---|
id | INT | Unique identifier | ||
card_refunded_amount | INT | How much was refunded to a gift card. | ||
credit_applied | INT | |||
customer_id | INT | Unique identifier for the customer | ||
financial_status | STRING | The order's financial status (See table below) | ||
fulfillment_status | STRING | The fulfillment status--either 1 (unfulfilled), 2 (partial), or 3 (fulfilled) | ||
gift_card_discount | INT | |||
gift_message | STRING | The gift message entered on checkout. | ||
gift_renewal_notif | BOOLEAN | |||
gross_shipping | INT | |||
is_gift | BOOL | Is this a gift order (Gifting 2 and 3 only!) | ||
order_gift_info | OrderGiftInfo | A sub-object containing gift_message, gift_recipient_email, and gift_recipient_name | ||
is_renewal | BOOLEAN | Note: This is false for "Charge Immediately" orders. | ||
is_test | BOOLEAN | |||
note | STRING | Note on the order | ||
placed_at | DATETIME | |||
prorated_charge | INT | |||
refund_applied | INT | |||
refunded_amount | INT | |||
status | STRING | Open (1) or Closed (2). | ||
store_id | INT | |||
sub_total | INT | |||
total | INT | |||
total_app_fees | INT | |||
total_label_cost | INT | |||
total_pending_fees | INT | |||
total_price | INT | |||
total_shipping | INT | |||
total_tax | INT | |||
transaction_fes | INT | |||
transaction_fee_status | INT | 1 (Paid), 2 (Pending Renewal), or 3 (Unpaid) | ||
type | STRING | Always order |
||
url | STRING |
Relation Properties
Property | Resource | Description | Filter? |
---|---|---|---|
customer | Customer | The customer the order belongs to | Yes |
products | Cart Products | A collection of CartProducts associated with the order | Yes |
Additional Related Properties
see Working with Object Relationships
Property | Resource | Description | Filter? |
---|---|---|---|
cart | Cart | Yes | |
logs | OrderLog | Yes | |
gifts | [Deprecated] Gifting 1.0 products. | Yes | |
coupons | Cart Coupon | If available, the coupons applied to the order. | Yes |
sent_gift | [Deprecated] Gifting 1.0 gift-giver. | Yes | |
bill_address | Address | The billing address for the order. | Yes |
ship_address | Address | The shipping address for the order. | Yes |
fulfillments | Fulfillment | The fulfillments associated with the order. | Yes |
transactions | Transaction | The transactions associated with the order | Yes |
subscriptions | Subscription | The subscriptions associated with the order. | Yes |
received_gift | [Deprecated] Gifting 1.0 gift-recipient. | Yes | |
referral_token | Yes |
The above properties on the order 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
Order Financial Status
To filter on financial_status, you'll need to filter using the integer values from this table:
Key | Status |
---|---|
1 | pending |
2 | authorized |
3 | partially_paid |
4 | paid |
5 | partially_refunded |
6 | refunded |
7 | voided |