API Documentation
curl -X POST '{backend_url}/store/gift-cards/{idOrCode}/redeem' \
-H 'Authorization: Bearer {access_token}' \
-H 'x-publishable-api-key: {your_publishable_api_key}'{
"gift_card": {
"customer": {
"id": "<string>",
"email": "[email protected]",
"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": "usd",
"province": "us-ca",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"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": {
"id": "<string>",
"item_id": "<string>",
"item": {
"detail": {
"id": "<string>",
"item_id": "<string>",
"item": {},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"title": "<string>",
"id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"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": {},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"refundable_total": 123,
"refundable_total_per_unit": 123,
"variant": {
"options": [
{}
],
"length": 123,
"title": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"product": {},
"metadata": {},
"product_id": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"calculated_price": {}
},
"product": {
"variants": [
{}
],
"options": [
{}
],
"images": [
{}
],
"length": 123,
"title": "<string>",
"status": "draft",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"subtitle": "<string>",
"thumbnail": "<string>",
"handle": "<string>",
"is_giftcard": true,
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"discountable": true,
"external_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {},
"categories": [
{}
],
"type": {},
"tags": [
{}
],
"metadata": {}
},
"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>"
}
],
"compare_at_unit_price": 123
},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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": {
"options": [
{
"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"
}
],
"length": 123,
"title": "<string>",
"id": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"product": {},
"metadata": {},
"product_id": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"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": {}
}
},
"product": {
"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",
"variants": [
{
"options": [
{
"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"
}
],
"length": 123,
"title": "<string>",
"id": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"product": {},
"metadata": {},
"product_id": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"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": {}
}
}
],
"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",
"categories": [
{}
],
"type": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"metadata": {},
"deleted_at": "2023-11-07T05:31:56Z"
},
"metadata": {},
"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": [
{}
]
},
"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": {}
}
]
},
"compare_at_unit_price": 123,
"tax_lines": [
{
"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": {},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"detail": {
"id": "<string>",
"item_id": "<string>",
"item": {},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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,
"variant": {
"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": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {},
"metadata": {}
},
"product": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"variants": [
{}
],
"options": [
{}
],
"images": [
{}
],
"discountable": true,
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {},
"categories": [
{}
],
"type": {},
"tags": [
{}
],
"metadata": {}
},
"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>"
}
]
},
"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": {
"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": {},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"detail": {
"id": "<string>",
"item_id": "<string>",
"item": {},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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,
"variant": {
"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": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {},
"metadata": {}
},
"product": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"variants": [
{}
],
"options": [
{}
],
"images": [
{}
],
"discountable": true,
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {},
"categories": [
{}
],
"type": {},
"tags": [
{}
],
"metadata": {}
},
"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>"
}
]
},
"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>"
}
]
},
"id": "<string>",
"code": "<string>",
"status": "pending",
"value": 123,
"currency_code": "usd",
"customer_id": "<string>",
"reference_id": "<string>",
"note": "<string>",
"reference": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Redeem a Gift Card
Redeem a gift card by its ID or code. The gift card will be added to the logged-in customer’s store credit account.
curl -X POST '{backend_url}/store/gift-cards/{idOrCode}/redeem' \
-H 'Authorization: Bearer {access_token}' \
-H 'x-publishable-api-key: {your_publishable_api_key}'{
"gift_card": {
"customer": {
"id": "<string>",
"email": "[email protected]",
"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": "usd",
"province": "us-ca",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"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": {
"id": "<string>",
"item_id": "<string>",
"item": {
"detail": {
"id": "<string>",
"item_id": "<string>",
"item": {},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"title": "<string>",
"id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"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": {},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"refundable_total": 123,
"refundable_total_per_unit": 123,
"variant": {
"options": [
{}
],
"length": 123,
"title": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"product": {},
"metadata": {},
"product_id": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"calculated_price": {}
},
"product": {
"variants": [
{}
],
"options": [
{}
],
"images": [
{}
],
"length": 123,
"title": "<string>",
"status": "draft",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"subtitle": "<string>",
"thumbnail": "<string>",
"handle": "<string>",
"is_giftcard": true,
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"discountable": true,
"external_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {},
"categories": [
{}
],
"type": {},
"tags": [
{}
],
"metadata": {}
},
"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>"
}
],
"compare_at_unit_price": 123
},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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": {
"options": [
{
"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"
}
],
"length": 123,
"title": "<string>",
"id": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"product": {},
"metadata": {},
"product_id": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"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": {}
}
},
"product": {
"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",
"variants": [
{
"options": [
{
"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"
}
],
"length": 123,
"title": "<string>",
"id": "<string>",
"width": 123,
"weight": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"product": {},
"metadata": {},
"product_id": "<string>",
"inventory_quantity": 123,
"variant_rank": 123,
"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": {}
}
}
],
"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",
"categories": [
{}
],
"type": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"metadata": {},
"deleted_at": "2023-11-07T05:31:56Z"
},
"metadata": {},
"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": [
{}
]
},
"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": {}
}
]
},
"compare_at_unit_price": 123,
"tax_lines": [
{
"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": {},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"detail": {
"id": "<string>",
"item_id": "<string>",
"item": {},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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,
"variant": {
"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": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {},
"metadata": {}
},
"product": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"variants": [
{}
],
"options": [
{}
],
"images": [
{}
],
"discountable": true,
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {},
"categories": [
{}
],
"type": {},
"tags": [
{}
],
"metadata": {}
},
"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>"
}
]
},
"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": {
"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": {},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"unit_price": 123,
"quantity": 123,
"detail": {
"id": "<string>",
"item_id": "<string>",
"item": {},
"quantity": 123,
"fulfilled_quantity": 123,
"delivered_quantity": 123,
"shipped_quantity": 123,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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,
"variant": {
"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": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"inventory_quantity": 123,
"variant_rank": 123,
"product": {},
"product_id": "<string>",
"calculated_price": {},
"metadata": {}
},
"product": {
"id": "<string>",
"title": "<string>",
"handle": "<string>",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection_id": "<string>",
"type_id": "<string>",
"variants": [
{}
],
"options": [
{}
],
"images": [
{}
],
"discountable": true,
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"collection": {},
"categories": [
{}
],
"type": {},
"tags": [
{}
],
"metadata": {}
},
"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>"
}
]
},
"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>"
}
]
},
"id": "<string>",
"code": "<string>",
"status": "pending",
"value": 123,
"currency_code": "usd",
"customer_id": "<string>",
"reference_id": "<string>",
"note": "<string>",
"reference": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Headers
Publishable API Key created in the Medusa Admin.
Path Parameters
The gift card's ID or code.
Query Parameters
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.
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.
Response
OK
The gift card's details.
The gift card's details.
Show child attributes
Show child attributes
The customer's details.
Show child attributes
Show child attributes
The customer's ID.
The customer's email.
The ID of the address used for billing by default.
The ID of the address used for shipping by default.
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 used for shipping by default.
Whether the address is used for billing by default.
The ID of the customer the address belongs to.
The address's company.
The address's first name.
The address's last name.
The address's first line.
The address's second line.
The address's city.
The address's country code.
"usd"
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, can hold custom key-value pairs.
The date the address was created.
The date the address was updated.
The customer's phone.
The customer's metadata, can hold custom key-value pairs.
The date the customer was created.
The date the customer was updated.
The date the customer was deleted.
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 item's detail.
Show child attributes
Show child attributes
the detail's ID.
the ID of the associated line item.
The detail's item.
Show child attributes
Show child attributes
The item's detail. The item's detail.
Show child attributes
Show child attributes
The detail's ID.
The detail's item id.
The detail's item. The detail's item.
The detail's quantity.
The detail's fulfilled quantity.
The detail's delivered quantity.
The detail's shipped quantity.
The detail's return requested quantity.
The detail's return received quantity.
The detail's return dismissed quantity.
The detail's written off quantity.
The detail's metadata.
The detail's created at.
The detail's updated at.
The item's title.
The item's ID.
The item's metadata.
The item's created at.
The item's updated at.
The item's item total.
The item's item subtotal.
The item's item tax total.
The item's original total.
The item's original subtotal.
The item's original tax total.
The item's total.
The item's subtotal.
The item's tax total.
The item's discount total.
The item's discount tax total.
The item's subtitle.
The item's thumbnail.
The item's variant id.
The item's product id.
The item's product title.
The item's product description.
The item's product subtitle.
The item's product type.
The item's product collection.
The item's product handle.
The item's variant sku.
The item's variant barcode.
The item's variant title.
The item's variant option values.
The item's requires shipping.
The item's is discountable.
The item's is tax inclusive.
The item's unit price.
The item's quantity.
The item's refundable total.
The item's refundable total per unit.
The item's variant.
Show child attributes
Show child attributes
The variant's options.
The variant's length.
The variant's title.
The variant's ID.
The variant's created at.
The variant's updated at.
The variant's width.
The variant's weight.
The variant's height.
The variant's origin country.
The variant's hs code.
The variant's mid code.
The variant's material.
The variant's deleted at.
The variant's sku.
The variant's barcode.
The variant's ean.
The variant's upc.
The variant's allow backorder.
The variant's manage inventory.
The variant's product.
The variant's metadata.
The variant's product id.
The variant's inventory quantity.
The variant's variant rank.
The variant's calculated price.
The item's product.
Show child attributes
Show child attributes
The product's variants.
The product's options.
The product's images.
The product's length.
The product's title.
The product's status.
draft, proposed, published, rejected The product's description.
The product's ID.
The product's created at.
The product's updated at.
The product's subtitle.
The product's thumbnail.
The product's handle.
The product's is giftcard.
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 product's collection id.
The product's type id.
The product's discountable.
The product's external id.
The product's deleted at.
The product's collection.
The product's categories.
The product's type.
The product's tags.
The product's metadata.
The item's tax lines.
Show child attributes
Show child attributes
The tax line's item. The tax line's item.
The tax line's item id.
The tax line's total.
The tax line's subtotal.
The tax line's ID.
The tax line's code.
The tax line's rate.
The tax line's created at.
The tax line's updated at.
The tax line's description.
The tax line's tax rate id.
The tax line's provider id.
The item's adjustments.
Show child attributes
Show child attributes
The adjustment's item. The adjustment's item.
The adjustment's item id.
The adjustment's ID.
The adjustment's amount.
The adjustment's order id.
The adjustment's created at.
The adjustment's updated at.
The adjustment's code.
The adjustment's description.
The adjustment's promotion id.
The adjustment's provider id.
The item's compare at unit price.
The item's quantity.
The item's fulfilled quantity.
The item's delivered quantity.
The item's shipped quantity.
The item's quantity that's requested to be returned.
The item's quantity that's returned and added to the underlying variant's stocked quantity.
The item's quantity that's returned but damaged. So, it's not added to the underlying variant's stocked quantity.
The item's quantity that's removed from the order.
The item's metadata, can hold custom key-value pairs.
The date the detail was created.
The date the detail was updated.
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 variant's details.
Show child attributes
Show child attributes
The variant's options.
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 variant's length.
The variant's title.
The variant's ID.
The variant's width.
The variant's weight.
The variant's height.
The variant's origin country.
The variant's HS code.
The variant's MID code.
The variant's material.
The date the variant was created.
The date the variant was updated.
The date the variant was deleted.
The variant's SKU.
The variant's barcode.
The variant's EAN.
The variant's UPC.
Whether the variant can be ordered even if it's not in stock.
Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
The variant's metadata, can hold custom key-value pairs.
The ID of the product this variant belongs to.
The variant's inventory quantity. This property is only available if you pass +variants.inventory_quantity in the fields query parameter.
The variant's rank among its siblings.
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 product's details.
Show child attributes
Show child attributes
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 option's ID.
The option's title.
The ID of the product this option belongs to.
The 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 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 variants.
Show child attributes
Show child attributes
The variant's options.
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 variant's length.
The variant's title.
The variant's ID.
The variant's width.
The variant's weight.
The variant's height.
The variant's origin country.
The variant's HS code.
The variant's MID code.
The variant's material.
The date the variant was created.
The date the variant was updated.
The date the variant was deleted.
The variant's SKU.
The variant's barcode.
The variant's EAN.
The variant's UPC.
Whether the variant can be ordered even if it's not in stock.
Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
The variant's metadata, can hold custom key-value pairs.
The ID of the product this variant belongs to.
The variant's inventory quantity. This property is only available if you pass +variants.inventory_quantity in the fields query parameter.
The variant's rank among its siblings.
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 product's handle.
The product's subtitle.
Whether the product is a gift card.
The product's thumbnail URL.
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 the product can be discounted.
The ID of the product in an external service or system.
The date the product was deleted.
The product's categories.
The product type's details.
Show child attributes
Show child attributes
The product type's ID.
The date the product type was created.
The date the product type was updated.
The type's value.
The product type's metadata, can hold custom key-value pairs.
The date the product type was deleted.
The product's metadata, can hold custom key-value pairs.
The collection's details.
Show child attributes
Show child attributes
The collection's ID.
The collection's title.
The collection's handle.
The date the collection was created.
The date the collection was updated.
The date the collection was deleted.
The collection's metadata, can hold custom key-value pairs.
The collection's products.
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 original price of the item before a promotion or sale.
The item's tax lines.
Show child attributes
Show child attributes
The tax line's item. The tax line's item.
Show child attributes
Show child attributes
The item's ID. The item's ID.
The item's title. The item's title.
The item's subtitle. The item's subtitle.
The item's thumbnail. The item's thumbnail.
The item's variant id. The item's variant id.
The item's product id. The item's product id.
The item's product title. The item's product title.
The item's product description. The item's product description.
The item's product subtitle. The item's product subtitle.
The item's product type. The item's product type.
The item's product collection. The item's product collection.
The item's product handle. The item's product handle.
The item's variant sku. The item's variant sku.
The item's variant barcode. The item's variant barcode.
The item's variant title. The item's variant title.
The item's variant option values. The item's variant option values.
The item's requires shipping. The item's requires shipping.
The item's is discountable. The item's is discountable.
The item's is tax inclusive. The item's is tax inclusive.
The item's unit price. The item's unit price.
The item's quantity. The item's quantity.
The item's detail. The item's detail. The item's detail.
Show child attributes
Show child attributes
The detail's ID. The detail's ID.
The detail's item id. The detail's item id.
The detail's item. The detail's item. The detail's item.
The detail's quantity. The detail's quantity.
The detail's fulfilled quantity. The detail's fulfilled quantity.
The detail's delivered quantity. The detail's delivered quantity.
The detail's shipped quantity. The detail's shipped quantity.
The detail's return requested quantity. The detail's return requested quantity.
The detail's return received quantity. The detail's return received quantity.
The detail's return dismissed quantity. The detail's return dismissed quantity.
The detail's written off quantity. The detail's written off quantity.
The detail's metadata. The detail's metadata.
The detail's created at. The detail's created at.
The detail's updated at. The detail's updated at.
The item's created at. The item's created at.
The item's updated at. The item's updated at.
The item's metadata. The item's metadata.
The item's original total. The item's original total.
The item's original subtotal. The item's original subtotal.
The item's original tax total. The item's original tax total.
The item's item total. The item's item total.
The item's item subtotal. The item's item subtotal.
The item's item tax total. The item's item tax total.
The item's total. The item's total.
The item's subtotal. The item's subtotal.
The item's tax total. The item's tax total.
The item's discount total. The item's discount total.
The item's discount tax total. The item's discount tax total.
The item's refundable total. The item's refundable total.
The item's refundable total per unit. The item's refundable total per unit.
The item's variant. The item's variant.
Show child attributes
Show child attributes
The variant's ID. The variant's ID.
The variant's title. The variant's title.
The variant's sku. The variant's sku.
The variant's barcode. The variant's barcode.
The variant's ean. The variant's ean.
The variant's upc. The variant's upc.
The variant's allow backorder. The variant's allow backorder.
The variant's manage inventory. The variant's manage inventory.
The variant's hs code. The variant's hs code.
The variant's origin country. The variant's origin country.
The variant's mid code. The variant's mid code.
The variant's material. The variant's material.
The variant's weight. The variant's weight.
The variant's length. The variant's length.
The variant's height. The variant's height.
The variant's width. The variant's width.
The variant's options. The variant's options.
The variant's created at. The variant's created at.
The variant's updated at. The variant's updated at.
The variant's deleted at. The variant's deleted at.
The variant's inventory quantity. The variant's inventory quantity.
The variant's variant rank. The variant's variant rank.
The variant's product. The variant's product.
The variant's product id. The variant's product id.
The variant's calculated price. The variant's calculated price.
The variant's metadata. The variant's metadata.
The item's product. The item's product.
Show child attributes
Show child attributes
The product's ID. The product's ID.
The product's title. The product's title.
The product's handle. The product's handle.
The product's subtitle. The product's subtitle.
The product's description. The product's description.
The product's is giftcard. The product's is giftcard.
The product's status. The product's status.
draft, proposed, published, rejected The product's thumbnail. The product's thumbnail.
The product's width. The product's width.
The product's weight. The product's weight.
The product's length. The product's length.
The product's height. The product's height.
The product's origin country. The product's origin country.
The product's hs code. The product's hs code.
The product's mid code. The product's mid code.
The product's material. The product's material.
The product's collection id. The product's collection id.
The product's type id. The product's type id.
The product's variants. The product's variants.
The product's options. The product's options.
The product's images. The product's images.
The product's discountable. The product's discountable.
The product's external id. The product's external id.
The product's created at. The product's created at.
The product's updated at. The product's updated at.
The product's deleted at. The product's deleted at.
The product's collection. The product's collection.
The product's categories. The product's categories.
The product's type. The product's type.
The product's tags. The product's tags.
The product's metadata. The product's metadata.
The item's compare at unit price. The item's compare at unit price.
The item's tax lines. The item's tax lines.
Show child attributes
Show child attributes
The tax line's item. The tax line's item. The tax line's item.
The tax line's item id. The tax line's item id.
The tax line's total. The tax line's total.
The tax line's subtotal. The tax line's subtotal.
The tax line's ID. The tax line's ID.
The tax line's code. The tax line's code.
The tax line's rate. The tax line's rate.
The tax line's created at. The tax line's created at.
The tax line's updated at. The tax line's updated at.
The tax line's description. The tax line's description.
The tax line's tax rate id. The tax line's tax rate id.
The tax line's provider id. The tax line's provider id.
The item's adjustments. The item's adjustments.
Show child attributes
Show child attributes
The adjustment's item. The adjustment's item. The adjustment's item.
The adjustment's item id. The adjustment's item id.
The adjustment's ID. The adjustment's ID.
The adjustment's amount. The adjustment's amount.
The adjustment's order id. The adjustment's order id.
The adjustment's created at. The adjustment's created at.
The adjustment's updated at. The adjustment's updated at.
The adjustment's code. The adjustment's code.
The adjustment's description. The adjustment's description.
The adjustment's promotion id. The adjustment's promotion id.
The adjustment's provider id. The adjustment's provider id.
The tax line's item id.
The tax line's total.
The tax line's subtotal.
The tax line's ID.
The tax line's code.
The tax line's rate.
The tax line's created at.
The tax line's updated at.
The tax line's description.
The tax line's tax rate id.
The tax line's provider id.
The item's adjustments.
Show child attributes
Show child attributes
The adjustment's item. The adjustment's item.
Show child attributes
Show child attributes
The item's ID. The item's ID.
The item's title. The item's title.
The item's subtitle. The item's subtitle.
The item's thumbnail. The item's thumbnail.
The item's variant id. The item's variant id.
The item's product id. The item's product id.
The item's product title. The item's product title.
The item's product description. The item's product description.
The item's product subtitle. The item's product subtitle.
The item's product type. The item's product type.
The item's product collection. The item's product collection.
The item's product handle. The item's product handle.
The item's variant sku. The item's variant sku.
The item's variant barcode. The item's variant barcode.
The item's variant title. The item's variant title.
The item's variant option values. The item's variant option values.
The item's requires shipping. The item's requires shipping.
The item's is discountable. The item's is discountable.
The item's is tax inclusive. The item's is tax inclusive.
The item's unit price. The item's unit price.
The item's quantity. The item's quantity.
The item's detail. The item's detail. The item's detail.
Show child attributes
Show child attributes
The detail's ID. The detail's ID.
The detail's item id. The detail's item id.
The detail's item. The detail's item. The detail's item.
The detail's quantity. The detail's quantity.
The detail's fulfilled quantity. The detail's fulfilled quantity.
The detail's delivered quantity. The detail's delivered quantity.
The detail's shipped quantity. The detail's shipped quantity.
The detail's return requested quantity. The detail's return requested quantity.
The detail's return received quantity. The detail's return received quantity.
The detail's return dismissed quantity. The detail's return dismissed quantity.
The detail's written off quantity. The detail's written off quantity.
The detail's metadata. The detail's metadata.
The detail's created at. The detail's created at.
The detail's updated at. The detail's updated at.
The item's created at. The item's created at.
The item's updated at. The item's updated at.
The item's metadata. The item's metadata.
The item's original total. The item's original total.
The item's original subtotal. The item's original subtotal.
The item's original tax total. The item's original tax total.
The item's item total. The item's item total.
The item's item subtotal. The item's item subtotal.
The item's item tax total. The item's item tax total.
The item's total. The item's total.
The item's subtotal. The item's subtotal.
The item's tax total. The item's tax total.
The item's discount total. The item's discount total.
The item's discount tax total. The item's discount tax total.
The item's refundable total. The item's refundable total.
The item's refundable total per unit. The item's refundable total per unit.
The item's variant. The item's variant.
Show child attributes
Show child attributes
The variant's ID. The variant's ID.
The variant's title. The variant's title.
The variant's sku. The variant's sku.
The variant's barcode. The variant's barcode.
The variant's ean. The variant's ean.
The variant's upc. The variant's upc.
The variant's allow backorder. The variant's allow backorder.
The variant's manage inventory. The variant's manage inventory.
The variant's hs code. The variant's hs code.
The variant's origin country. The variant's origin country.
The variant's mid code. The variant's mid code.
The variant's material. The variant's material.
The variant's weight. The variant's weight.
The variant's length. The variant's length.
The variant's height. The variant's height.
The variant's width. The variant's width.
The variant's options. The variant's options.
The variant's created at. The variant's created at.
The variant's updated at. The variant's updated at.
The variant's deleted at. The variant's deleted at.
The variant's inventory quantity. The variant's inventory quantity.
The variant's variant rank. The variant's variant rank.
The variant's product. The variant's product.
The variant's product id. The variant's product id.
The variant's calculated price. The variant's calculated price.
The variant's metadata. The variant's metadata.
The item's product. The item's product.
Show child attributes
Show child attributes
The product's ID. The product's ID.
The product's title. The product's title.
The product's handle. The product's handle.
The product's subtitle. The product's subtitle.
The product's description. The product's description.
The product's is giftcard. The product's is giftcard.
The product's status. The product's status.
draft, proposed, published, rejected The product's thumbnail. The product's thumbnail.
The product's width. The product's width.
The product's weight. The product's weight.
The product's length. The product's length.
The product's height. The product's height.
The product's origin country. The product's origin country.
The product's hs code. The product's hs code.
The product's mid code. The product's mid code.
The product's material. The product's material.
The product's collection id. The product's collection id.
The product's type id. The product's type id.
The product's variants. The product's variants.
The product's options. The product's options.
The product's images. The product's images.
The product's discountable. The product's discountable.
The product's external id. The product's external id.
The product's created at. The product's created at.
The product's updated at. The product's updated at.
The product's deleted at. The product's deleted at.
The product's collection. The product's collection.
The product's categories. The product's categories.
The product's type. The product's type.
The product's tags. The product's tags.
The product's metadata. The product's metadata.
The item's compare at unit price. The item's compare at unit price.
The item's tax lines. The item's tax lines.
Show child attributes
Show child attributes
The tax line's item. The tax line's item. The tax line's item.
The tax line's item id. The tax line's item id.
The tax line's total. The tax line's total.
The tax line's subtotal. The tax line's subtotal.
The tax line's ID. The tax line's ID.
The tax line's code. The tax line's code.
The tax line's rate. The tax line's rate.
The tax line's created at. The tax line's created at.
The tax line's updated at. The tax line's updated at.
The tax line's description. The tax line's description.
The tax line's tax rate id. The tax line's tax rate id.
The tax line's provider id. The tax line's provider id.
The item's adjustments. The item's adjustments.
Show child attributes
Show child attributes
The adjustment's item. The adjustment's item. The adjustment's item.
The adjustment's item id. The adjustment's item id.
The adjustment's ID. The adjustment's ID.
The adjustment's amount. The adjustment's amount.
The adjustment's order id. The adjustment's order id.
The adjustment's created at. The adjustment's created at.
The adjustment's updated at. The adjustment's updated at.
The adjustment's code. The adjustment's code.
The adjustment's description. The adjustment's description.
The adjustment's promotion id. The adjustment's promotion id.
The adjustment's provider id. The adjustment's provider id.
The adjustment's item id.
The adjustment's ID.
The adjustment's amount.
The adjustment's order id.
The adjustment's created at.
The adjustment's updated at.
The adjustment's code.
The adjustment's description.
The adjustment's promotion id.
The adjustment's provider id.
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 that the gift card belongs to.
The gift card's reference ID.
A note with more information about the gift card.
The gift card's reference.
The date the gift card expires.
The date the gift card was created.
The date the gift card was updated.