curl '{backend_url}/admin/gift-cards' \
-H 'Authorization: Bearer {jwt_token}'{
"limit": 123,
"offset": 123,
"count": 123,
"gift_cards": [
{
"line_item": {
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"thumbnail": "<string>",
"variant_id": "<string>",
"product_id": "<string>",
"product_title": "<string>",
"product_description": "<string>",
"product_subtitle": "<string>",
"product_type": "<string>",
"product_collection": "<string>",
"product_handle": "<string>",
"variant_sku": "<string>",
"variant_barcode": "<string>",
"variant_title": "<string>",
"variant_option_values": {
"Color": "Blue"
},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"detail": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"metadata": {},
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"refundable_total": 123,
"refundable_total_per_unit": 123,
"product_type_id": "<string>",
"variant": {
"prices": [
{
"id": "<string>",
"title": "<string>",
"currency_code": "usd",
"amount": 123,
"raw_amount": {},
"min_quantity": 123,
"max_quantity": 123,
"price_set_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"value": "<string>",
"option": {
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"option_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"thumbnail": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {
"id": "<string>",
"calculated_amount": 123,
"original_amount": 123,
"currency_code": "usd",
"original_amount_with_tax": 123,
"original_amount_without_tax": 123,
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount_with_tax": 123,
"calculated_amount_without_tax": 123,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"calculated_price": {},
"original_price": {}
},
"metadata": {},
"inventory_items": [
{
"id": "<string>",
"variant_id": "<string>",
"inventory_item_id": "<string>",
"variant": {},
"inventory": {
"id": "<string>",
"requires_shipping": true,
"sku": "<string>",
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"title": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"metadata": {},
"location_levels": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_item_id": "<string>",
"location_id": "<string>",
"stocked_quantity": 123,
"reserved_quantity": 123,
"incoming_quantity": 123,
"metadata": {},
"available_quantity": 123,
"inventory_item": {}
}
]
},
"required_quantity": 123
}
]
},
"product": {
"variants": [
{
"prices": [
{
"id": "<string>",
"title": "<string>",
"currency_code": "usd",
"amount": 123,
"raw_amount": {},
"min_quantity": 123,
"max_quantity": 123,
"price_set_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"value": "<string>",
"option": {
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"option_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"thumbnail": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {
"id": "<string>",
"calculated_amount": 123,
"original_amount": 123,
"currency_code": "usd",
"original_amount_with_tax": 123,
"original_amount_without_tax": 123,
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount_with_tax": 123,
"calculated_amount_without_tax": 123,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"calculated_price": {},
"original_price": {}
},
"metadata": {},
"inventory_items": [
{
"id": "<string>",
"variant_id": "<string>",
"inventory_item_id": "<string>",
"variant": {},
"inventory": {
"id": "<string>",
"requires_shipping": true,
"sku": "<string>",
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"title": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"metadata": {},
"location_levels": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_item_id": "<string>",
"location_id": "<string>",
"stocked_quantity": 123,
"reserved_quantity": 123,
"incoming_quantity": 123,
"metadata": {},
"available_quantity": 123,
"inventory_item": {}
}
]
},
"required_quantity": 123
}
]
}
],
"type": {
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
},
"length": 123,
"title": "<string>",
"status": "draft",
"options": [
{
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"subtitle": "<string>",
"is_giftcard": true,
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"product": {},
"variants": [
{}
]
}
],
"discountable": true,
"external_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"products": [
{
"variants": [
{}
],
"length": 123,
"title": "<string>",
"status": "draft",
"options": [
{
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{
"id": "<string>",
"value": "<string>",
"option": {},
"option_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"subtitle": "<string>",
"is_giftcard": true,
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"discountable": true,
"external_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"products": [
{}
]
},
"categories": [
{
"category_children": [
{
"category_children": [
{}
],
"parent_category": {},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
}
],
"parent_category": {
"category_children": [
{}
],
"parent_category": {},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
}
],
"type": {
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
},
"tags": [
{
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"metadata": {}
}
]
},
"categories": [
{
"category_children": [
{}
],
"parent_category": {},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
}
],
"sales_channels": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_disabled": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"tags": [
{
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"metadata": {},
"shipping_profile": {
"id": "<string>",
"name": "<string>",
"type": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
},
"compare_at_unit_price": 123,
"tax_lines": [
{
"item": {},
"item_id": "<string>",
"total": 123,
"subtotal": 123,
"id": "<string>",
"code": "<string>",
"rate": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"tax_rate_id": "<string>",
"provider_id": "<string>"
}
],
"adjustments": [
{
"item": {},
"item_id": "<string>",
"id": "<string>",
"amount": 123,
"order_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"promotion_id": "<string>",
"provider_id": "<string>"
}
]
},
"customer": {
"id": "<string>",
"has_account": true,
"email": "jsmith@example.com",
"default_billing_address_id": "<string>",
"default_shipping_address_id": "<string>",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"addresses": [
{
"id": "<string>",
"address_name": "<string>",
"is_default_shipping": true,
"is_default_billing": true,
"customer_id": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "us",
"province": "us-ca",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"groups": [
{
"id": "<string>",
"name": "<string>",
"customers": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"phone": "<string>",
"metadata": {},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"code": "<string>",
"status": "pending",
"value": 123,
"currency_code": "usd",
"customer_id": "<string>",
"reference_id": "<string>",
"note": "<string>",
"reference": "<string>",
"expires_at": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"estimate_count": 123
}List Gift Cards
Retrieve a list of gift cards. The gift cards can be filtered by fields such as id. The gift cards can also be sorted or paginated.
curl '{backend_url}/admin/gift-cards' \
-H 'Authorization: Bearer {jwt_token}'{
"limit": 123,
"offset": 123,
"count": 123,
"gift_cards": [
{
"line_item": {
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"thumbnail": "<string>",
"variant_id": "<string>",
"product_id": "<string>",
"product_title": "<string>",
"product_description": "<string>",
"product_subtitle": "<string>",
"product_type": "<string>",
"product_collection": "<string>",
"product_handle": "<string>",
"variant_sku": "<string>",
"variant_barcode": "<string>",
"variant_title": "<string>",
"variant_option_values": {
"Color": "Blue"
},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"detail": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"metadata": {},
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"refundable_total": 123,
"refundable_total_per_unit": 123,
"product_type_id": "<string>",
"variant": {
"prices": [
{
"id": "<string>",
"title": "<string>",
"currency_code": "usd",
"amount": 123,
"raw_amount": {},
"min_quantity": 123,
"max_quantity": 123,
"price_set_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"value": "<string>",
"option": {
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"option_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"thumbnail": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {
"id": "<string>",
"calculated_amount": 123,
"original_amount": 123,
"currency_code": "usd",
"original_amount_with_tax": 123,
"original_amount_without_tax": 123,
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount_with_tax": 123,
"calculated_amount_without_tax": 123,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"calculated_price": {},
"original_price": {}
},
"metadata": {},
"inventory_items": [
{
"id": "<string>",
"variant_id": "<string>",
"inventory_item_id": "<string>",
"variant": {},
"inventory": {
"id": "<string>",
"requires_shipping": true,
"sku": "<string>",
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"title": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"metadata": {},
"location_levels": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_item_id": "<string>",
"location_id": "<string>",
"stocked_quantity": 123,
"reserved_quantity": 123,
"incoming_quantity": 123,
"metadata": {},
"available_quantity": 123,
"inventory_item": {}
}
]
},
"required_quantity": 123
}
]
},
"product": {
"variants": [
{
"prices": [
{
"id": "<string>",
"title": "<string>",
"currency_code": "usd",
"amount": 123,
"raw_amount": {},
"min_quantity": 123,
"max_quantity": 123,
"price_set_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"value": "<string>",
"option": {
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"option_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"thumbnail": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {
"id": "<string>",
"calculated_amount": 123,
"original_amount": 123,
"currency_code": "usd",
"original_amount_with_tax": 123,
"original_amount_without_tax": 123,
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount_with_tax": 123,
"calculated_amount_without_tax": 123,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"calculated_price": {},
"original_price": {}
},
"metadata": {},
"inventory_items": [
{
"id": "<string>",
"variant_id": "<string>",
"inventory_item_id": "<string>",
"variant": {},
"inventory": {
"id": "<string>",
"requires_shipping": true,
"sku": "<string>",
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"title": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"metadata": {},
"location_levels": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_item_id": "<string>",
"location_id": "<string>",
"stocked_quantity": 123,
"reserved_quantity": 123,
"incoming_quantity": 123,
"metadata": {},
"available_quantity": 123,
"inventory_item": {}
}
]
},
"required_quantity": 123
}
]
}
],
"type": {
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
},
"length": 123,
"title": "<string>",
"status": "draft",
"options": [
{
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"subtitle": "<string>",
"is_giftcard": true,
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"product": {},
"variants": [
{}
]
}
],
"discountable": true,
"external_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"products": [
{
"variants": [
{}
],
"length": 123,
"title": "<string>",
"status": "draft",
"options": [
{
"id": "<string>",
"title": "<string>",
"product": {},
"product_id": "<string>",
"values": [
{
"id": "<string>",
"value": "<string>",
"option": {},
"option_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"subtitle": "<string>",
"is_giftcard": true,
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"discountable": true,
"external_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {},
"products": [
{}
]
},
"categories": [
{
"category_children": [
{
"category_children": [
{}
],
"parent_category": {},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
}
],
"parent_category": {
"category_children": [
{}
],
"parent_category": {},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
}
],
"type": {
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
},
"tags": [
{
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"metadata": {}
}
]
},
"categories": [
{
"category_children": [
{}
],
"parent_category": {},
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category_id": "<string>",
"products": [
{}
],
"metadata": {}
}
],
"sales_channels": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_disabled": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"tags": [
{
"id": "<string>",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"metadata": {},
"shipping_profile": {
"id": "<string>",
"name": "<string>",
"type": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
},
"compare_at_unit_price": 123,
"tax_lines": [
{
"item": {},
"item_id": "<string>",
"total": 123,
"subtotal": 123,
"id": "<string>",
"code": "<string>",
"rate": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"tax_rate_id": "<string>",
"provider_id": "<string>"
}
],
"adjustments": [
{
"item": {},
"item_id": "<string>",
"id": "<string>",
"amount": 123,
"order_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"promotion_id": "<string>",
"provider_id": "<string>"
}
]
},
"customer": {
"id": "<string>",
"has_account": true,
"email": "jsmith@example.com",
"default_billing_address_id": "<string>",
"default_shipping_address_id": "<string>",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"addresses": [
{
"id": "<string>",
"address_name": "<string>",
"is_default_shipping": true,
"is_default_billing": true,
"customer_id": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "us",
"province": "us-ca",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"groups": [
{
"id": "<string>",
"name": "<string>",
"customers": [
{}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"phone": "<string>",
"metadata": {},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"code": "<string>",
"status": "pending",
"value": 123,
"currency_code": "usd",
"customer_id": "<string>",
"reference_id": "<string>",
"note": "<string>",
"reference": "<string>",
"expires_at": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"estimate_count": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The gift card's ID.
Filter by a customer ID to retrieve their gift cards.
Filter by a gift card's creation date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by a gift card's update date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Limit the number of items returned in the list.
The number of items to skip when retrieving a list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Response
OK
The paginated list of gift cards.
The maximum number of gift cards to return.
The number of gift cards to skip before retrieving the results.
The total number of gift cards available.
The list of gift cards.
Show child attributes
Show child attributes
The item's details.
Show child attributes
Show child attributes
The item's ID.
The item's title.
The item's subtitle.
The URL of the item's thumbnail.
The ID of the associated variant.
The ID of the associated product.
The item's product title.
The item's product description.
The item's product subtitle.
The item's product type.
The ID of the collection the item's product belongs to.
The item's product handle.
The item's variant SKU.
The item's variant barcode.
The item's variant title.
The values of the item variant's options.
{ "Color": "Blue" }Whether the item requires shipping.
Whether the item is discountable.
Whether the item is tax inclusive.
The item's unit price.
The item's quantity.
The date the item was created.
The date the item was updated.
The item's metadata, can hold custom key-value pairs.
The item's total including taxes, excluding promotions.
The item's total excluding taxes, including promotions.
The total taxes of the item, excluding promotions.
The total taxes of the item, including promotions.
The item's total excluding taxes, including promotions.
The total taxes of the item, including promotions.
The item's total, including taxes and promotions.
The item's subtotal excluding taxes, including promotions.
The tax total of the item including promotions.
The total discount amount of the item.
The total taxes applied on the discounted amount.
The total refundable amount of the item's total.
The total refundable amount of the item's total for a single quantity.
The ID of the associated product's type.
The product variant's details.
Show child attributes
Show child attributes
The variant's prices.
Show child attributes
Show child attributes
The price's ID.
The price's title.
The price's currency code.
"usd"
The price's amount.
The price's raw amount.
The minimum quantity that must be available in the cart for the price to be applied.
The maximum quantity allowed to be available in the cart for the price to be applied.
The ID of the associated price set.
The date the price was created.
The date the price was updated.
The date the price was deleted.
The variant's ID.
The variant's title.
The variant's SKU.
The variant's barcode.
The variant's EAN code.
The variant's UPC.
Whether the variant can be ordered even if it's out of stock.
Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock.
The variant's HS code.
The variant's origin country.
The variant's MID code.
The variant's material.
The variant's weight.
The variant's length.
The variant's height.
The variant's width.
The variant's option values.
Show child attributes
Show child attributes
The value's ID.
The value.
The product option's details.
Show child attributes
Show child attributes
The product option's ID.
The product option's title.
The ID of the product this option belongs to.
The product option's values.
The product option's metadata, can hold custom key-value pairs.
The date the product option was created.
The date the product option was updated.
The date the product option was deleted.
The ID of the option this value belongs to.
The value's metadata, can hold custom key-value pairs.
The date the value was created.
The date the value was updated.
The date the value was deleted.
The date the variant was created.
The date the variant was updated.
The date the variant was deleted.
The variant's images.
Show child attributes
Show child attributes
The image's ID.
The image's URL.
The image's rank among its sibling images.
The date the image was created.
The date the image was updated.
The date the image was deleted.
The image's metadata, can hold custom key-value pairs.
The variant's thumbnail.
The variant's inventory quantity. This is only included if you pass in the fields query parameter a +variants.inventory_quantity parameter.
The variant's rank among its sibling variants.
The ID of the product that the variant belongs to.
The calculated price's details.
Show child attributes
Show child attributes
The calculated price's ID.
The amount of the calculated price, or null if there isn't a calculated price. This is the amount shown to the customer.
The amount of the original price, or null if there isn't an original price. This amount is useful to compare with the calculated_amount, such as to check for discounted value.
The calculated price's currency code.
"usd"
The amount of the original price with taxes applied.
The amount of the original price without taxes.
Whether the calculated price belongs to a price list.
Whether the calculated price is tax inclusive.
The calculated price's amount with taxes applied.
The calculated price's amount without taxes applied.
Whether the original price belongs to a price list.
Whether the original price is tax inclusive.
The calculated price's details.
The original price's details.
The variant's metadata, can hold custom key-value pairs.
The variant's inventory items.
Show child attributes
Show child attributes
The ID of the association.
The associated product variant's ID.
The associated inventory item's ID.
The inventory item's details.
Show child attributes
Show child attributes
The inventory item's ID.
Whether the inventory item requires shipping.
The inventory item's sku.
The inventory item's origin country.
The inventory item's HS code.
The inventory item's MID code.
The inventory item's material.
The inventory item's weight.
The inventory item's length.
The inventory item's height.
The inventory item's width.
The inventory item's title.
The inventory item's description.
The thumbnail URL of the inventory item.
Custom key-value pairs, used to store additional information about the inventory item.
The inventory item's location levels.
Show child attributes
Show child attributes
The location level's ID.
The location level's created at.
The location level's updated at.
The location level's deleted at.
The location level's inventory item id.
The location level's location id.
The location level's stocked quantity.
The location level's reserved quantity.
The location level's incoming quantity.
The location level's metadata.
The location level's available quantity.
The inventory item's required quantity.
The product's details.
Show child attributes
Show child attributes
The product's variants.
Show child attributes
Show child attributes
The variant's prices.
Show child attributes
Show child attributes
The price's ID.
The price's title.
The price's currency code.
"usd"
The price's amount.
The price's raw amount.
The minimum quantity that must be available in the cart for the price to be applied.
The maximum quantity allowed to be available in the cart for the price to be applied.
The ID of the associated price set.
The date the price was created.
The date the price was updated.
The date the price was deleted.
The variant's ID.
The variant's title.
The variant's SKU.
The variant's barcode.
The variant's EAN code.
The variant's UPC.
Whether the variant can be ordered even if it's out of stock.
Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock.
The variant's HS code.
The variant's origin country.
The variant's MID code.
The variant's material.
The variant's weight.
The variant's length.
The variant's height.
The variant's width.
The variant's option values.
Show child attributes
Show child attributes
The value's ID.
The value.
The product option's details.
Show child attributes
Show child attributes
The product option's ID.
The product option's title.
The ID of the product this option belongs to.
The product option's values.
The product option's metadata, can hold custom key-value pairs.
The date the product option was created.
The date the product option was updated.
The date the product option was deleted.
The ID of the option this value belongs to.
The value's metadata, can hold custom key-value pairs.
The date the value was created.
The date the value was updated.
The date the value was deleted.
The date the variant was created.
The date the variant was updated.
The date the variant was deleted.
The variant's images.
Show child attributes
Show child attributes
The image's ID.
The image's URL.
The image's rank among its sibling images.
The date the image was created.
The date the image was updated.
The date the image was deleted.
The image's metadata, can hold custom key-value pairs.
The variant's thumbnail.
The variant's inventory quantity. This is only included if you pass in the fields query parameter a +variants.inventory_quantity parameter.
The variant's rank among its sibling variants.
The ID of the product that the variant belongs to.
The calculated price's details.
Show child attributes
Show child attributes
The calculated price's ID.
The amount of the calculated price, or null if there isn't a calculated price. This is the amount shown to the customer.
The amount of the original price, or null if there isn't an original price. This amount is useful to compare with the calculated_amount, such as to check for discounted value.
The calculated price's currency code.
"usd"
The amount of the original price with taxes applied.
The amount of the original price without taxes.
Whether the calculated price belongs to a price list.
Whether the calculated price is tax inclusive.
The calculated price's amount with taxes applied.
The calculated price's amount without taxes applied.
Whether the original price belongs to a price list.
Whether the original price is tax inclusive.
The calculated price's details.
The original price's details.
The variant's metadata, can hold custom key-value pairs.
The variant's inventory items.
Show child attributes
Show child attributes
The ID of the association.
The associated product variant's ID.
The associated inventory item's ID.
The inventory item's details.
Show child attributes
Show child attributes
The inventory item's ID.
Whether the inventory item requires shipping.
The inventory item's sku.
The inventory item's origin country.
The inventory item's HS code.
The inventory item's MID code.
The inventory item's material.
The inventory item's weight.
The inventory item's length.
The inventory item's height.
The inventory item's width.
The inventory item's title.
The inventory item's description.
The thumbnail URL of the inventory item.
Custom key-value pairs, used to store additional information about the inventory item.
The inventory item's location levels.
Show child attributes
Show child attributes
The location level's ID.
The location level's created at.
The location level's updated at.
The location level's deleted at.
The location level's inventory item id.
The location level's location id.
The location level's stocked quantity.
The location level's reserved quantity.
The location level's incoming quantity.
The location level's metadata.
The location level's available quantity.
The inventory item's required quantity.
The product type's details.
Show child attributes
Show child attributes
The type's ID.
The type's value.
The date the type was created.
The date the type was updated.
The date the type was deleted.
The type's metadata, can hold custom key-value pairs.
The product's length.
The product's title.
The product's status.
draft, proposed, published, rejected The product's options.
Show child attributes
Show child attributes
The product option's ID.
The product option's title.
The ID of the product this option belongs to.
The product option's values.
The product option's metadata, can hold custom key-value pairs.
The date the product option was created.
The date the product option was updated.
The date the product option was deleted.
The product's description.
The product's ID.
The date the product was created.
The date the product was updated.
The product's unique handle.
The product's subtitle.
Whether the product is a gift card.
The product's thumbnail.
The product's width.
The product's weight.
The product's height.
The product's origin country.
The product's HS code.
The product's MID code.
The product's material.
The ID of the collection that the product belongs to.
The ID of the product's type.
The product's images.
Show child attributes
Show child attributes
The image's ID.
The image's URL.
The image's rank among sibling images.
The date the image was created.
The date the image was updated.
The date the image was deleted.
The image's metadata, can hold custom key-value pairs.
The variants associated with the image.
Whether discounts can be applied on the product.
The ID of a product in an external system, such as an ERP or CMS.
The date the product was deleted.
The product collection's details.
Show child attributes
Show child attributes
The collection's ID.
The collection's title.
The collection's handle.
The collection's creation date.
The collection's update date.
The collection's deletion date.
The collection's metadata, used to store custom key-value pairs.
The collection's products.
Show child attributes
Show child attributes
The product's variants.
The product's length.
The product's title.
The product's status.
draft, proposed, published, rejected The product's options.
Show child attributes
Show child attributes
The product option's ID.
The product option's title.
The ID of the product this option belongs to.
The product option's values.
Show child attributes
Show child attributes
The value's ID.
The value.
The ID of the option this value belongs to.
The value's metadata, can hold custom key-value pairs.
The date the value was created.
The date the value was updated.
The date the value was deleted.
The product option's metadata, can hold custom key-value pairs.
The date the product option was created.
The date the product option was updated.
The date the product option was deleted.
The product's description.
The product's ID.
The date the product was created.
The date the product was updated.
The product's unique handle.
The product's subtitle.
Whether the product is a gift card.
The product's thumbnail.
The product's width.
The product's weight.
The product's height.
The product's origin country.
The product's HS code.
The product's MID code.
The product's material.
The ID of the collection that the product belongs to.
The ID of the product's type.
The product's images.
Show child attributes
Show child attributes
The image's ID.
The image's URL.
The image's rank among its sibling images.
The date the image was created.
The date the image was updated.
The date the image was deleted.
The image's metadata, can hold custom key-value pairs.
Whether discounts can be applied on the product.
The ID of a product in an external system, such as an ERP or CMS.
The date the product was deleted.
The product collection's details.
Show child attributes
Show child attributes
The collection's ID.
The collection's title.
The collection's handle.
The collection's creation date.
The collection's update date.
The collection's deletion date.
The collection's metadata, used to store custom key-value pairs.
The collection's products.
The product's categories.
Show child attributes
Show child attributes
The category's children.
Show child attributes
Show child attributes
The category's children.
The category's name.
The category's description.
The category's ID.
The date the category was created.
The date the category was updated.
The category's unique handle.
The date the category was deleted.
Whether the category is active. If disabled, the category isn't shown in the storefront.
Whether the category is internal. If enabled, the category is only seen by admin users.
The category's rank among sibling categories.
The ID of the category's parent.
The category's products.
The category's metadata, can hold custom key-value pairs.
The product category's details.
Show child attributes
Show child attributes
The category's children.
The category's name.
The category's description.
The category's ID.
The date the category was created.
The date the category was updated.
The category's unique handle.
The date the category was deleted.
Whether the category is active. If disabled, the category isn't shown in the storefront.
Whether the category is internal. If enabled, the category is only seen by admin users.
The category's rank among sibling categories.
The ID of the category's parent.
The category's products.
The category's metadata, can hold custom key-value pairs.
The category's name.
The category's description.
The category's ID.
The date the category was created.
The date the category was updated.
The category's unique handle.
The date the category was deleted.
Whether the category is active. If disabled, the category isn't shown in the storefront.
Whether the category is internal. If enabled, the category is only seen by admin users.
The category's rank among sibling categories.
The ID of the category's parent.
The category's products.
The category's metadata, can hold custom key-value pairs.
The product type's details.
Show child attributes
Show child attributes
The type's ID.
The type's value.
The date the type was created.
The date the type was updated.
The date the type was deleted.
The type's metadata, can hold custom key-value pairs.
The product's tags.
Show child attributes
Show child attributes
The tag's ID.
The tag's value.
The date the tag was created.
The date the tag was updated.
The date the tag was deleted.
The tag's metadata, can hold custom key-value pairs.
The product's metadata, can hold custom key-value pairs.
The product's categories.
Show child attributes
Show child attributes
The category's children.
The category's name.
The category's description.
The category's ID.
The date the category was created.
The date the category was updated.
The category's unique handle.
The date the category was deleted.
Whether the category is active. If disabled, the category isn't shown in the storefront.
Whether the category is internal. If enabled, the category is only seen by admin users.
The category's rank among sibling categories.
The ID of the category's parent.
The category's products.
The category's metadata, can hold custom key-value pairs.
The sales channels that the product is available in.
Show child attributes
Show child attributes
The sales channel's ID.
The sales channel's name.
The sales channel's description.
Whether the sales channel is disabled.
The sales channel's metadata, can hold custom key-value pairs.
The date the sales channel was created.
The date the sales channel was updated.
The date the sales channel was deleted.
The product's tags.
Show child attributes
Show child attributes
The tag's ID.
The tag's value.
The date the tag was created.
The date the tag was updated.
The date the tag was deleted.
The tag's metadata, can hold custom key-value pairs.
The product's metadata, can hold custom key-value pairs.
The shipping profile's details..
Show child attributes
Show child attributes
The shipping profile's ID.
The shipping profile's name.
The shipping profile's type.
The shipping profile's metadata, holds custom key-value pairs.
The date the shipping profile was created.
The date the shipping profile was updated.
The date the shipping profile was deleted.
The original price of the item before a promotion or sale.
The item's tax lines.
Show child attributes
Show child attributes
The ID of the associated line item.
The tax line's total including promotions.
The tax line's subtotal excluding promotions.
The tax line's ID.
The code that the tax rate is identified by.
The rate to charge.
The date the tax line was created.
The date the tax line was updated.
The tax line's description.
The ID of the applied tax rate.
The ID of the tax provider used to calculate the tax line.
The item's adjustments.
Show child attributes
Show child attributes
The ID of the item this adjustment applies to.
The adjustment's ID.
The adjustment's amount.
The ID of the associated order.
The date the adjustment was created.
The date the adjustment was updated.
The adjustment's code.
The adjustment's description.
The ID of the promotion that this applies on the order's item.
The adjustment's provider ID.
The customer's details.
Show child attributes
Show child attributes
The customer's ID.
Whether the customer is registered.
The customer's email.
The ID of the address used as the default billing address.
The ID of the address used as the default shipping address.
The customer's company name.
The customer's first name.
The customer's last name.
The customer's addresses.
Show child attributes
Show child attributes
The address's ID.
The address's name.
Whether the address is the default shipping address.
Whether the address is the default billing address.
The ID of the customer that this address belongs to.
The customer's company.
The customer's first name.
The customer's last name.
The address's first line.
The address's second line.
The address's city.
The address's country code.
"us"
The address's lower-case ISO 3166-2 province code.
"us-ca"
The address's postal code.
The address's phone.
The address's metadata, used to store custom key-value pairs.
The address's creation date.
The address's update date.
The customer's groups.
Show child attributes
Show child attributes
The customer group's ID.
The customer group's name.
The customer group's customers.
The customer group's metadata, used to store custom key-value pairs.
The customer group's creation date.
The customer group's update date.
The customer's phone.
The customer's metadata, used to store custom key-value pairs.
The ID of the user that created this customer, if available.
The customer's creation date.
The customer's update date.
The customer's deletion date.
The gift card's ID.
The gift card's code.
The gift card's status.
pending, redeemed The gift card's amount.
The gift card's currency code.
"usd"
The ID of the customer associated with the gift card.
The gift card's reference ID.
The gift card's note.
The gift card's reference.
The date the gift card expires at.
The date the gift card was created at.
The date the gift card was updated at.
The gift card's estimate count.