Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Products
  • Plugins
    • List Plugins
      GET
  • Auth
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Generate Reset Password Token for Admin User
      POST
    • Retrieve Registration JWT Token
      POST
    • Authenticate User
      POST
    • Set Authentication Session
      POST
    • Delete Authentication Session
      DELETE
    • Reset an Admin User's Password
      POST
  • Draft Orders
    • Create a Draft Order Edit
    • Cancel Edit on Draft Order
    • Confirm an Edit on a Draft Order
    • Request Edit on Draft Order
    • Convert a Draft Order to an Order
    • Add Item to Draft Order Edit
    • Update Existing Item in Draft Order Edit
    • Remove Item from Draft Order Edit
    • Update New Item in Draft Order Edit
    • Add Promotions to Draft Order Edit
    • Remove Promotions from Draft Order Edit
    • Add Shipping Method to Draft Order Edit
    • Remove Shipping Method from Draft Order Edit
    • Update Existing Shipping Method in Draft Order Edit
    • Remove New Shipping Method from Draft Order
    • Update New Shipping Method in Draft Order Edit
    • Delete a Draft Order
    • Get a Draft Order
    • Update a Draft Order
    • Create Draft Order
    • List Draft Orders
  • Fulfillment Providers
    • List Fulfillment Options
    • List Fulfillment Providers
  • Fulfillment Sets
    • Delete Fulfillment Set
    • Add a Service Zone to a Fulfillment Set
    • Remove a Service Zone from Fulfillment Set
    • Get a Service Zone in a Fulfillment Set
    • Update the Service Zone of a Fulfillment Set
  • Inventory Items
    • Manage Inventory Levels
    • Manage Inventory Levels of Inventory Item
    • Create Inventory Level for Inventory Item
    • List Inventory Levels
    • Update an Inventory Level of an Inventory Item
    • Remove Inventory Level of Inventory Item
    • Create Inventory Item
    • List Inventory Items
    • Get a Inventory Item
    • Delete Inventory Item
    • Update an Inventory Item
  • Order Edits
    • Create Order Edit
    • Confirm Order Edit
    • Request Order Edit
    • Add Items to Order Edit
    • Update Order Item Quantity of Order Edit
    • Remove Item from Order Edit
    • Update an Item in an Order Edit
    • Add Shipping Method to Order Edit
    • Remove Shipping Method from Order Edit
    • Update Shipping Method of an Order Edit
    • Cancel Order Edit
  • Orders
    • List Changes on an Order
    • Mark a Fulfillment as Delivered.
    • Get Preview
    • Archive an Order
    • Cancel Order
    • Cancel Transfer Request
    • Create Credit Line for Order
    • Request Order Transfer
    • Complete Order
    • Update Order
    • Get an Order
    • List Line Items
    • Cancel Fulfillment
    • Create an Order Fulfillment
    • Create Shipment for an Order's Fulfillment
    • List Orders
  • Payment Collections
    • Delete a Payment Collection
    • Create Payment Collection
    • Mark a Payment Collection as Paid
  • Products
    • Create Product Import
      POST
    • Confirm Product Import
      POST
    • Export Products
      POST
    • Manage Products
      POST
    • Manage Variants in a Product
      POST
    • Associate Variant with Inventory Item
      POST
    • Remove Inventory Item Association with Product Variant
      DELETE
    • Update Product Variant's Inventory Details
      POST
    • Delete a Product
      DELETE
    • Get a Product
      GET
    • Update a Product
      POST
    • Create a Product Option
      POST
    • List a Product's Options
      GET
    • Get a Product's Option
      GET
    • Delete an Option from Product
      DELETE
    • Update a Product's Option
      POST
    • Get Variant of a Product
      GET
    • Delete Product Variant
      DELETE
    • Update a Product Variant
      POST
    • Manage Variants Inventory in a Product
      POST
    • Create a Product Variant
      POST
    • List Variants of a Product
      GET
    • Create Product
      POST
    • List Products
      GET
  • Claims
    • Get a Claim
    • Cancel a Claim
    • Add Inbound Items to a Claim
    • Remove an Inbound Item from Claim
    • Update Inbound Items of a Claim
    • Add an Inbound Shipping Method to a Claim
    • Cancel Claim Request
    • Confirm a Claim Request
    • Add Claim Items to a Claim
    • Remove a Claim Item from a Claim
    • Update a Claim Item
    • Remove Inbound Shipping Method from Claim
    • Update Inbound Shipping Method of a Claim
    • Add Outbound Items to a Claim
    • Remove an Outbound Item from Claim
    • Update Outbound Item of a Claim
    • Add Outbound Shipping Methods to a Claim
    • Remove Outbound Shipping Method from Claim
    • Update Outbound Shipping Method of a Claim
    • Create a Claim
    • List Claims
  • Currencies
    • Get a Currency
    • List Currencies
  • Exchanges
    • Get an Exchange
    • Cancel an Exchange
    • Add Inbound Items to an Exchange
    • Remove Inbound Item from Exchange
    • Update an Inbount Item of an Exchange
    • Add an Inbound Shipping Method to an Exchange
    • Cancel Exchange Request
    • Confirm an Exchange
    • Remove Inbound Shipping Method from Exchange
    • Update Inbound Shipping Method of an Exchange
    • Add Outbound Items to Exchange
    • Remove Outbound Item from Exchange
    • Update Outbound Item of an Exchange
    • Add Outbound Shipping Method to Exchange
    • Remove Outbound Shipping Method from Exchange
    • Update Outbound Shipping Method of Exchange
    • Create Exchange
    • List Exchanges
  • Fulfillments
    • Cancel a Fulfillment
    • Create Fulfillment
    • Create a Shipment for a Fulfillment
  • Invites
    • Refresh Invite Token
    • Get an Invite
    • Delete Invite
    • Accept Invite
    • Create Invite
    • List Invites
  • Notifications
    • Get a Notification
    • List Notifications
  • Payments
    • Get a Payment
    • Capture Payment
    • Refund Payment
    • List Payment Providers
    • List Payments
  • Returns
    • Cancel a return.
    • Get a Return
    • Update a Return
    • Add Damaged Items to Return
    • Remove Damaged Item from Return
    • Update Damaged Item of Return
    • Add Received Items to Return
    • Remove a Received Item from Return
    • Update a Received Item in a Return
    • Confirm Return Receival
    • Add Requested Items to Return
    • Remove Item from Return
    • Update Requested Item in Return
    • Add a Shipping Method to a Return
    • Remove Shipping Method from Return
    • Update a Shipping Method of a Return
    • Start Return Receival
    • Cancel Return Receival
    • Confirm Return Request
    • Cancel Return Request
    • Create Return
    • List Returns
  • Users
    • Get Logged-In User
    • Delete a User
    • Get a User
    • Update a User
    • List Users
  • Workflows Executions
    • Get a Workflows Execution
    • Subscribe to a Workflow's Execution
    • Get Workflow Execution's Details
    • Subscribe to Step of a Workflow's Execution
    • Fail a Step in a Workflow's Execution
    • Succeed a Step in a Workflow's Execution
    • List Workflows Executions
    • Execute a Workflow
  • Api Keys
    • Revoke API Key
    • Get API Key
    • Update an API Key
    • Delete an Api Key
    • Manage Sales Channels of a Publishable API Key
    • Create Api Key
    • List API Keys
  • Price Lists
    • Remove Products from Price List
    • Delete a Price List
    • Get a Price List
    • Update a Price List
    • Manage Prices in Price List
    • Create Price List
    • List Price Lists
  • Stores
    • Get a Store
    • Update a Store
    • List Stores
  • Tax Rates
    • Create Tax Rule for a Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Remove Rule of Tax Rate
    • Create Tax Rate
    • List Tax Rates
  • Price Preferences
    • Delete a Price Preference
    • Get a Price Preference
    • Update a Price Preference
    • Create Price Preference
    • List Price Preferences
  • Return Reasons
    • Delete a Return Reason
    • Get a Return Reason
    • Update a Return Reason
    • Create Return Reason
    • List Return Reasons
  • Sales Channels
    • Delete a Sales Channel
    • Get a Sales Channel
    • Update a Sales Channel
    • Manage Products in Sales Channel
    • Create Sales Channel
    • List Sales Channels
  • Stock Locations
    • Delete a Stock Location
    • Get a Stock Location
    • Update a Stock Location
    • Add Fulfillment Set to Stock Location
    • Manage Fulfillment Providers of a Stock Location
    • Manage Sales Channels of a Stock Location
    • Create Stock Location
    • List Stock Locations
  • Tax Regions
    • Delete a Tax Region
    • Update a Tax Region
    • Get a Tax Region
    • Create Tax Region
    • List Tax Regions
  • Promotions
    • List Rule Attribute Options of a Rule Type
    • List Rules of a Promotion
    • List Rule Values Given a Rule Attribute
    • Manage the Buy Rules of a Promotion
    • Manage a Promotion's Rules
    • Manage Target Rules of a Promotion
    • Get a Promotion
    • Delete a Promotion
    • Update a Promotion
    • List Promotions
    • Create Promotion
  • Customer Groups
    • Get a Customer Group
    • Update a Customer Group
    • Delete a Customer Group
    • Manage Customers of a Customer Group
    • Create Customer Group
    • List Customer Groups
  • Product Tags
    • Delete a Product Tag
    • Get a Product Tag
    • Update a Product Tag
    • Create Product Tag
    • List Product Tags
  • Product Types
    • Delete a Product Type
    • Get a Product Type
    • Update a Product Type
    • Create Product Type
    • List Product Types
  • Refund Reasons
    • Get a Refund Reason
    • Update a Refund Reason
    • Delete a Refund Reason
    • Create Refund Reason
    • List Refund Reasons
  • Uploads
    • Get a File
    • Delete a File
    • Upload Files
  • Campaigns
    • Manage the Promotions of a Campaign
    • Get a Campaign
    • Delete a Campaign
    • Update a Campaign
    • List Campaigns
    • Create Campaign
  • Collections
    • Manage Products of a Collection
    • Delete a Collection
    • Get a Collection
    • Update a Collection
    • Create Collection
    • List Collections
  • Customers
    • Manage Customer Groups of Customer
    • Get a Customer
    • Delete a Customer
    • Update a Customer
    • List Addresses
    • Add a Customer Address
    • List Addresses
    • Remove an Address from Customer
    • Update a Customer's Address
    • Create Customer
    • List Customers
  • Product Categories
    • Manage Products in Product Category
    • Delete a Product Category
    • Get a Product Category
    • Update a Product Category
    • Create Product Category
    • List Product Categories
  • Reservations
    • Get a Reservation
    • Update a Reservation
    • Delete a Reservation
    • Create Reservation
    • List Reservations
  • Shipping Profiles
    • Delete a Shipping Profile
    • Get a Shipping Profile
    • Update a Shipping Profile
    • Create Shipping Profile
    • List Shipping Profiles
  • Regions
    • Get a Region
    • Delete a Region
    • Update a Region
    • Create Region
    • List Regions
  • Tax Providers
    • List Tax Providers
  • Shipping Options
    • Manage the Rules of a Shipping Option
    • Create Shipping Option
    • List Shipping Options
    • Delete a Shipping Option
    • Get a Shipping Option
    • Update a Shipping Option
  • Product Variants
    • List Product Variants
  1. Products

Manage Products

POST
/admin/products/batch
Products
Manage products to create, update, or delete them.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request POST '{{BASE_URL}}/admin/products/batch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "create": [
        {
            "title": "string",
            "subtitle": "string",
            "description": "string",
            "is_giftcard": true,
            "discountable": true,
            "thumbnail": "string",
            "handle": "string",
            "type_id": "string",
            "collection_id": "string",
            "options": [
                {
                    "title": "string",
                    "values": [
                        "string"
                    ]
                }
            ],
            "variants": [
                {
                    "title": "string",
                    "sku": "string",
                    "ean": "string",
                    "upc": "string",
                    "barcode": "string",
                    "hs_code": "string",
                    "mid_code": "string",
                    "allow_backorder": true,
                    "manage_inventory": true,
                    "variant_rank": 0,
                    "weight": 0,
                    "length": 0,
                    "height": 0,
                    "width": 0,
                    "origin_country": "string",
                    "material": "string",
                    "metadata": {},
                    "prices": [
                        {
                            "currency_code": "string",
                            "amount": 0,
                            "min_quantity": 0,
                            "max_quantity": 0,
                            "rules": {
                                "region_id": "reg_123"
                            }
                        }
                    ],
                    "inventory_items": [
                        {
                            "inventory_item_id": "string",
                            "required_quantity": 0
                        }
                    ],
                    "options": {
                        "Color": "Black"
                    }
                }
            ],
            "weight": 0,
            "length": 0,
            "height": 0,
            "width": 0,
            "hs_code": "string",
            "mid_code": "string",
            "origin_country": "string",
            "material": "string",
            "metadata": {},
            "external_id": "string",
            "shipping_profile_id": "string",
            "status": "draft",
            "images": [
                {
                    "url": "string"
                }
            ],
            "categories": [
                {
                    "id": "string"
                }
            ],
            "tags": [
                {
                    "id": "string"
                }
            ],
            "sales_channels": [
                {
                    "id": "string"
                }
            ]
        }
    ],
    "update": [
        {
            "title": "string",
            "subtitle": "string",
            "description": "string",
            "is_giftcard": true,
            "discountable": true,
            "thumbnail": "string",
            "handle": "string",
            "type_id": "string",
            "collection_id": "string",
            "options": [
                {
                    "title": "string",
                    "values": [
                        "string"
                    ]
                }
            ],
            "weight": 0,
            "length": 0,
            "height": 0,
            "width": 0,
            "hs_code": "string",
            "mid_code": "string",
            "origin_country": "string",
            "material": "string",
            "metadata": {},
            "external_id": "string",
            "id": "string",
            "shipping_profile_id": "string",
            "status": "draft",
            "variants": [
                {
                    "title": "string",
                    "sku": "string",
                    "ean": "string",
                    "upc": "string",
                    "barcode": "string",
                    "hs_code": "string",
                    "mid_code": "string",
                    "allow_backorder": true,
                    "manage_inventory": true,
                    "variant_rank": 0,
                    "weight": 0,
                    "length": 0,
                    "height": 0,
                    "width": 0,
                    "origin_country": "string",
                    "material": "string",
                    "metadata": {},
                    "prices": [
                        {
                            "currency_code": "string",
                            "amount": 0,
                            "min_quantity": 0,
                            "max_quantity": 0,
                            "rules": {
                                "region_id": "reg_123"
                            }
                        }
                    ],
                    "inventory_items": [
                        {
                            "inventory_item_id": "string",
                            "required_quantity": 0
                        }
                    ],
                    "options": {
                        "Color": "Black"
                    }
                }
            ],
            "images": [
                {
                    "url": "string"
                }
            ],
            "categories": [
                {
                    "id": "string"
                }
            ],
            "tags": [
                {
                    "id": "string"
                }
            ],
            "sales_channels": [
                {
                    "id": "string"
                }
            ]
        }
    ],
    "delete": [
        "string"
    ]
}'
Response Response Example
200 - Example 1
{
    "created": [
        {
            "collection": {
                "id": "string",
                "title": "string",
                "handle": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "products": [
                    {
                        "collection": {
                            "id": "string",
                            "title": "string",
                            "handle": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z",
                            "metadata": {},
                            "products": [
                                {}
                            ]
                        },
                        "type": {
                            "id": "string",
                            "value": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z",
                            "metadata": {}
                        },
                        "categories": [
                            {
                                "parent_category": {
                                    "parent_category": {},
                                    "name": "string",
                                    "description": "string",
                                    "id": "string",
                                    "metadata": {},
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z",
                                    "handle": "string",
                                    "deleted_at": "2019-08-24T14:15:22Z",
                                    "is_active": true,
                                    "is_internal": true,
                                    "rank": 0,
                                    "parent_category_id": "string",
                                    "category_children": [
                                        {}
                                    ],
                                    "products": [
                                        {}
                                    ]
                                },
                                "category_children": [
                                    {
                                        "parent_category": {},
                                        "name": "string",
                                        "description": "string",
                                        "id": "string",
                                        "metadata": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "handle": "string",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "is_active": true,
                                        "is_internal": true,
                                        "rank": 0,
                                        "parent_category_id": "string",
                                        "category_children": [
                                            {}
                                        ],
                                        "products": [
                                            {}
                                        ]
                                    }
                                ],
                                "name": "string",
                                "description": "string",
                                "id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "handle": "string",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "is_active": true,
                                "is_internal": true,
                                "rank": 0,
                                "parent_category_id": "string",
                                "products": [
                                    {}
                                ]
                            }
                        ],
                        "tags": [
                            {
                                "id": "string",
                                "value": "string",
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {}
                            }
                        ],
                        "length": 0,
                        "title": "string",
                        "options": [
                            {
                                "id": "string",
                                "title": "string",
                                "product": {},
                                "product_id": "string",
                                "values": [
                                    {
                                        "id": "string",
                                        "value": "string",
                                        "option": {},
                                        "option_id": "string",
                                        "metadata": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z"
                                    }
                                ],
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ],
                        "description": "string",
                        "id": "string",
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "handle": "string",
                        "subtitle": "string",
                        "is_giftcard": true,
                        "thumbnail": "string",
                        "width": 0,
                        "weight": 0,
                        "height": 0,
                        "origin_country": "string",
                        "hs_code": "string",
                        "mid_code": "string",
                        "material": "string",
                        "collection_id": "string",
                        "type_id": "string",
                        "images": [
                            {
                                "id": "string",
                                "url": "string",
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {},
                                "rank": 0
                            }
                        ],
                        "discountable": true,
                        "external_id": "string",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "variants": [
                            {}
                        ],
                        "status": "draft"
                    }
                ],
                "metadata": {}
            },
            "type": {
                "id": "string",
                "value": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {}
            },
            "shipping_profile": {
                "id": "string",
                "name": "string",
                "type": "string",
                "metadata": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z"
            },
            "categories": [
                {
                    "parent_category": {},
                    "name": "string",
                    "description": "string",
                    "id": "string",
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "handle": "string",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "is_active": true,
                    "is_internal": true,
                    "rank": 0,
                    "parent_category_id": "string",
                    "category_children": [
                        {}
                    ],
                    "products": [
                        {}
                    ]
                }
            ],
            "sales_channels": [
                {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "is_disabled": true,
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z"
                }
            ],
            "variants": [
                {
                    "calculated_price": {
                        "id": "string",
                        "is_calculated_price_price_list": true,
                        "is_calculated_price_tax_inclusive": true,
                        "calculated_amount": 0,
                        "calculated_amount_with_tax": 0,
                        "calculated_amount_without_tax": 0,
                        "is_original_price_price_list": true,
                        "is_original_price_tax_inclusive": true,
                        "original_amount": 0,
                        "currency_code": "usd",
                        "calculated_price": {},
                        "original_price": {},
                        "original_amount_with_tax": 0,
                        "original_amount_without_tax": 0
                    },
                    "prices": [
                        {
                            "id": "string",
                            "title": "string",
                            "currency_code": "usd",
                            "amount": 0,
                            "raw_amount": {},
                            "min_quantity": 0,
                            "max_quantity": 0,
                            "price_set_id": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z"
                        }
                    ],
                    "id": "string",
                    "title": "string",
                    "sku": "string",
                    "barcode": "string",
                    "ean": "string",
                    "upc": "string",
                    "allow_backorder": true,
                    "manage_inventory": true,
                    "inventory_quantity": 0,
                    "hs_code": "string",
                    "origin_country": "string",
                    "mid_code": "string",
                    "material": "string",
                    "weight": 0,
                    "length": 0,
                    "height": 0,
                    "width": 0,
                    "variant_rank": 0,
                    "options": [
                        {
                            "option": {
                                "id": "string",
                                "title": "string",
                                "product": {},
                                "product_id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "values": [
                                    {}
                                ]
                            },
                            "id": "string",
                            "value": "string",
                            "option_id": "string",
                            "metadata": {},
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z"
                        }
                    ],
                    "product": {},
                    "product_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {},
                    "inventory_items": [
                        {
                            "inventory": {
                                "id": "string",
                                "sku": "string",
                                "origin_country": "string",
                                "hs_code": "string",
                                "requires_shipping": true,
                                "mid_code": "string",
                                "material": "string",
                                "weight": 0,
                                "length": 0,
                                "height": 0,
                                "width": 0,
                                "title": "string",
                                "description": "string",
                                "thumbnail": "string",
                                "metadata": {},
                                "location_levels": [
                                    {
                                        "id": "string",
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "inventory_item_id": "string",
                                        "location_id": "string",
                                        "stocked_quantity": 0,
                                        "reserved_quantity": 0,
                                        "incoming_quantity": 0,
                                        "metadata": {},
                                        "inventory_item": {},
                                        "available_quantity": 0
                                    }
                                ]
                            },
                            "id": "string",
                            "variant_id": "string",
                            "variant": {},
                            "inventory_item_id": "string"
                        }
                    ]
                }
            ],
            "tags": [
                {
                    "id": "string",
                    "value": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {}
                }
            ],
            "length": 0,
            "title": "string",
            "options": [
                {
                    "id": "string",
                    "title": "string",
                    "product": {},
                    "product_id": "string",
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "values": [
                        {}
                    ]
                }
            ],
            "description": "string",
            "id": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "handle": "string",
            "subtitle": "string",
            "is_giftcard": true,
            "thumbnail": "string",
            "width": 0,
            "weight": 0,
            "height": 0,
            "origin_country": "string",
            "hs_code": "string",
            "mid_code": "string",
            "material": "string",
            "collection_id": "string",
            "type_id": "string",
            "images": [
                {
                    "id": "string",
                    "url": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {},
                    "rank": 0
                }
            ],
            "discountable": true,
            "external_id": "string",
            "deleted_at": "2019-08-24T14:15:22Z",
            "status": "draft"
        }
    ],
    "updated": [
        {
            "collection": {
                "id": "string",
                "title": "string",
                "handle": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "products": [
                    {
                        "collection": {
                            "id": "string",
                            "title": "string",
                            "handle": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z",
                            "metadata": {},
                            "products": [
                                {}
                            ]
                        },
                        "type": {
                            "id": "string",
                            "value": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z",
                            "metadata": {}
                        },
                        "categories": [
                            {
                                "parent_category": {
                                    "parent_category": {},
                                    "name": "string",
                                    "description": "string",
                                    "id": "string",
                                    "metadata": {},
                                    "created_at": "2019-08-24T14:15:22Z",
                                    "updated_at": "2019-08-24T14:15:22Z",
                                    "handle": "string",
                                    "deleted_at": "2019-08-24T14:15:22Z",
                                    "is_active": true,
                                    "is_internal": true,
                                    "rank": 0,
                                    "parent_category_id": "string",
                                    "category_children": [
                                        {}
                                    ],
                                    "products": [
                                        {}
                                    ]
                                },
                                "category_children": [
                                    {
                                        "parent_category": {},
                                        "name": "string",
                                        "description": "string",
                                        "id": "string",
                                        "metadata": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "handle": "string",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "is_active": true,
                                        "is_internal": true,
                                        "rank": 0,
                                        "parent_category_id": "string",
                                        "category_children": [
                                            {}
                                        ],
                                        "products": [
                                            {}
                                        ]
                                    }
                                ],
                                "name": "string",
                                "description": "string",
                                "id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "handle": "string",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "is_active": true,
                                "is_internal": true,
                                "rank": 0,
                                "parent_category_id": "string",
                                "products": [
                                    {}
                                ]
                            }
                        ],
                        "tags": [
                            {
                                "id": "string",
                                "value": "string",
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {}
                            }
                        ],
                        "length": 0,
                        "title": "string",
                        "options": [
                            {
                                "id": "string",
                                "title": "string",
                                "product": {},
                                "product_id": "string",
                                "values": [
                                    {
                                        "id": "string",
                                        "value": "string",
                                        "option": {},
                                        "option_id": "string",
                                        "metadata": {},
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z"
                                    }
                                ],
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ],
                        "description": "string",
                        "id": "string",
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "handle": "string",
                        "subtitle": "string",
                        "is_giftcard": true,
                        "thumbnail": "string",
                        "width": 0,
                        "weight": 0,
                        "height": 0,
                        "origin_country": "string",
                        "hs_code": "string",
                        "mid_code": "string",
                        "material": "string",
                        "collection_id": "string",
                        "type_id": "string",
                        "images": [
                            {
                                "id": "string",
                                "url": "string",
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {},
                                "rank": 0
                            }
                        ],
                        "discountable": true,
                        "external_id": "string",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "variants": [
                            {}
                        ],
                        "status": "draft"
                    }
                ],
                "metadata": {}
            },
            "type": {
                "id": "string",
                "value": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {}
            },
            "shipping_profile": {
                "id": "string",
                "name": "string",
                "type": "string",
                "metadata": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z"
            },
            "categories": [
                {
                    "parent_category": {},
                    "name": "string",
                    "description": "string",
                    "id": "string",
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "handle": "string",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "is_active": true,
                    "is_internal": true,
                    "rank": 0,
                    "parent_category_id": "string",
                    "category_children": [
                        {}
                    ],
                    "products": [
                        {}
                    ]
                }
            ],
            "sales_channels": [
                {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "is_disabled": true,
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z"
                }
            ],
            "variants": [
                {
                    "calculated_price": {
                        "id": "string",
                        "is_calculated_price_price_list": true,
                        "is_calculated_price_tax_inclusive": true,
                        "calculated_amount": 0,
                        "calculated_amount_with_tax": 0,
                        "calculated_amount_without_tax": 0,
                        "is_original_price_price_list": true,
                        "is_original_price_tax_inclusive": true,
                        "original_amount": 0,
                        "currency_code": "usd",
                        "calculated_price": {},
                        "original_price": {},
                        "original_amount_with_tax": 0,
                        "original_amount_without_tax": 0
                    },
                    "prices": [
                        {
                            "id": "string",
                            "title": "string",
                            "currency_code": "usd",
                            "amount": 0,
                            "raw_amount": {},
                            "min_quantity": 0,
                            "max_quantity": 0,
                            "price_set_id": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z"
                        }
                    ],
                    "id": "string",
                    "title": "string",
                    "sku": "string",
                    "barcode": "string",
                    "ean": "string",
                    "upc": "string",
                    "allow_backorder": true,
                    "manage_inventory": true,
                    "inventory_quantity": 0,
                    "hs_code": "string",
                    "origin_country": "string",
                    "mid_code": "string",
                    "material": "string",
                    "weight": 0,
                    "length": 0,
                    "height": 0,
                    "width": 0,
                    "variant_rank": 0,
                    "options": [
                        {
                            "option": {
                                "id": "string",
                                "title": "string",
                                "product": {},
                                "product_id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "values": [
                                    {}
                                ]
                            },
                            "id": "string",
                            "value": "string",
                            "option_id": "string",
                            "metadata": {},
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z",
                            "deleted_at": "2019-08-24T14:15:22Z"
                        }
                    ],
                    "product": {},
                    "product_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {},
                    "inventory_items": [
                        {
                            "inventory": {
                                "id": "string",
                                "sku": "string",
                                "origin_country": "string",
                                "hs_code": "string",
                                "requires_shipping": true,
                                "mid_code": "string",
                                "material": "string",
                                "weight": 0,
                                "length": 0,
                                "height": 0,
                                "width": 0,
                                "title": "string",
                                "description": "string",
                                "thumbnail": "string",
                                "metadata": {},
                                "location_levels": [
                                    {
                                        "id": "string",
                                        "created_at": "2019-08-24T14:15:22Z",
                                        "updated_at": "2019-08-24T14:15:22Z",
                                        "deleted_at": "2019-08-24T14:15:22Z",
                                        "inventory_item_id": "string",
                                        "location_id": "string",
                                        "stocked_quantity": 0,
                                        "reserved_quantity": 0,
                                        "incoming_quantity": 0,
                                        "metadata": {},
                                        "inventory_item": {},
                                        "available_quantity": 0
                                    }
                                ]
                            },
                            "id": "string",
                            "variant_id": "string",
                            "variant": {},
                            "inventory_item_id": "string"
                        }
                    ]
                }
            ],
            "tags": [
                {
                    "id": "string",
                    "value": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {}
                }
            ],
            "length": 0,
            "title": "string",
            "options": [
                {
                    "id": "string",
                    "title": "string",
                    "product": {},
                    "product_id": "string",
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "values": [
                        {}
                    ]
                }
            ],
            "description": "string",
            "id": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "handle": "string",
            "subtitle": "string",
            "is_giftcard": true,
            "thumbnail": "string",
            "width": 0,
            "weight": 0,
            "height": 0,
            "origin_country": "string",
            "hs_code": "string",
            "mid_code": "string",
            "material": "string",
            "collection_id": "string",
            "type_id": "string",
            "images": [
                {
                    "id": "string",
                    "url": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {},
                    "rank": 0
                }
            ],
            "discountable": true,
            "external_id": "string",
            "deleted_at": "2019-08-24T14:15:22Z",
            "status": "draft"
        }
    ],
    "deleted": {
        "object": "product",
        "deleted": true,
        "ids": [
            "string"
        ]
    }
}

Request

Authorization
or
or
or
Query Params
fields
string 
fields
optional
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.
Body Params application/json
The products to create, update, or delete.
create
array[object (AdminCreateProduct) {27}] 
optional
The products to create.
title
string 
title
required
The product's title.
subtitle
string 
subtitle
optional
The product's subtitle.
description
string 
description
optional
The product's description.
is_giftcard
boolean 
is_giftcard
optional
Whether the product is a gift card.
discountable
boolean 
discountable
optional
Whether the product is discountable.
thumbnail
string 
thumbnail
optional
The URL of the product's thumbnail.
handle
string 
handle
optional
The product's handle.
type_id
string 
type_id
optional
The ID of the type the product belongs to.
collection_id
string 
collection_id
optional
The ID of the collection the product belongs to.
options
array[object (AdminCreateProductOption) {2}] 
required
The product's options.
variants
array[object (AdminCreateProductVariant) {20}] 
optional
The product's variants.
weight
number 
weight
optional
The product's weight.
length
number 
length
optional
The product's length.
height
number 
height
optional
The product's height.
width
number 
width
optional
The product's width.
hs_code
string 
hs_code
optional
The product's HS code.
mid_code
string 
mid_code
optional
The product's MID code.
origin_country
string 
origin_country
optional
The product's origin country.
material
string 
material
optional
The product's material.
metadata
object 
optional
The product's metadata, used to store custom key-value pairs.
external_id
string 
external_id
optional
The ID of the product in an external or third-party system.
shipping_profile_id
string 
shipping_profile_id
optional
The ID of the product's shipping profile.
status
enum<string> 
optional
The product's status.
Allowed values:
draftproposedpublishedrejected
images
array [object {1}] 
optional
The product's images.
categories
array [object {1}] 
optional
The categories the product belongs to.
tags
array [object {1}] 
optional
The product's tags.
sales_channels
array [object {1}] 
optional
The sales channels the product is available in.
update
array[object (AdminBatchUpdateProduct) {28}] 
optional
The products to update.
title
string 
title
optional
The product's title.
subtitle
string 
subtitle
optional
The product's subtitle.
description
string 
description
optional
The product's description.
is_giftcard
boolean 
is_giftcard
optional
Whether the product is a gift card.
discountable
boolean 
discountable
optional
Whether discounts can be applied on the product.
thumbnail
string 
thumbnail
optional
The product's thumbnail URL.
handle
string 
handle
optional
The product's unique handle.
type_id
string 
type_id
optional
The ID of the product's type.
collection_id
string 
collection_id
optional
The ID of the product's collection.
options
array[object (AdminUpdateProductOption) {2}] 
optional
The product's options.
weight
number 
weight
optional
The product's weight.
length
number 
length
optional
The product's length.
height
number 
height
optional
The product's height.
width
number 
width
optional
The product's width.
hs_code
string 
hs_code
optional
The product's HS code.
mid_code
string 
mid_code
optional
The product's MID code.
origin_country
string 
origin_country
optional
The product's origin country.
material
string 
material
optional
The product's material.
metadata
object 
optional
The product's metadata, can hold custom key-value pairs.
external_id
string 
external_id
optional
The ID of the product in an external or third-party system.
id
string 
id
required
The product's ID.
shipping_profile_id
string 
shipping_profile_id
optional
The ID of the product's shipping profile.
status
enum<string> 
optional
The product's status.
Allowed values:
draftproposedpublishedrejected
variants
array [oneOf] 
optional
The product's variants. You can add new variants or update existing ones, passing their IDs in the object.
images
array [object {1}] 
optional
The product's images.
categories
array [object {1}] 
optional
The product's categories.
tags
array [object {1}] 
optional
The product's tags.
sales_channels
array [object {1}] 
optional
The sales channels that the product is available in.
delete
array[string]
optional
The products to delete.
Examples

Responses

🟢200OK
application/json
OK
Body
The details of the products created, updated, or deleted.
created
array[object (AdminProduct) {33}] 
required
The created products
collection
object (AdminCollection) 
optional
The product collection's details.
type
object (AdminProductType) 
required
The product type's details.
shipping_profile
object (AdminShippingProfile) 
optional
The shipping profile's details..
categories
array[object (AdminProductCategory) {15}] 
optional
The product's categories.
sales_channels
array[object (AdminSalesChannel) {8}] 
optional
The sales channels that the product is available in.
variants
array[object (AdminProductVariant) {28}] 
required
The product's variants.
tags
array[object (AdminProductTag) {6}] 
optional
The product's tags.
length
number 
length
required
The product's length.
title
string 
title
required
The product's title.
options
array[object (AdminProductOption) {9}] 
required
The product's options.
description
string 
description
required
The product's description.
id
string 
id
required
The product's ID.
metadata
object 
optional
The product's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
required
The date the product was created.
updated_at
string <date-time>
updated_at
required
The date the product was updated.
handle
string 
handle
required
The product's unique handle.
subtitle
string 
subtitle
required
The product's subtitle.
is_giftcard
boolean 
is_giftcard
required
Whether the product is a gift card.
thumbnail
string 
thumbnail
required
The product's thumbnail.
width
number 
width
required
The product's width.
weight
number 
weight
required
The product's weight.
height
number 
height
required
The product's height.
origin_country
string 
origin_country
required
The product's origin country.
hs_code
string 
hs_code
required
The product's HS code.
mid_code
string 
mid_code
required
The product's MID code.
material
string 
material
required
The product's material.
collection_id
string 
collection_id
required
The ID of the collection that the product belongs to.
type_id
string 
type_id
required
The ID of the product's type.
images
array[object (AdminProductImage) {7}] 
required
The product's images.
discountable
boolean 
discountable
required
Whether discounts can be applied on the product.
external_id
string 
external_id
required
The ID of a product in an external system, such as an ERP or CMS.
deleted_at
string <date-time>
deleted_at
required
The date the product was deleted.
status
enum<string> 
required
The product's status.
Allowed values:
draftproposedpublishedrejected
updated
array[object (AdminProduct) {33}] 
required
The updated products.
collection
object (AdminCollection) 
optional
The product collection's details.
type
object (AdminProductType) 
required
The product type's details.
shipping_profile
object (AdminShippingProfile) 
optional
The shipping profile's details..
categories
array[object (AdminProductCategory) {15}] 
optional
The product's categories.
sales_channels
array[object (AdminSalesChannel) {8}] 
optional
The sales channels that the product is available in.
variants
array[object (AdminProductVariant) {28}] 
required
The product's variants.
tags
array[object (AdminProductTag) {6}] 
optional
The product's tags.
length
number 
length
required
The product's length.
title
string 
title
required
The product's title.
options
array[object (AdminProductOption) {9}] 
required
The product's options.
description
string 
description
required
The product's description.
id
string 
id
required
The product's ID.
metadata
object 
optional
The product's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
required
The date the product was created.
updated_at
string <date-time>
updated_at
required
The date the product was updated.
handle
string 
handle
required
The product's unique handle.
subtitle
string 
subtitle
required
The product's subtitle.
is_giftcard
boolean 
is_giftcard
required
Whether the product is a gift card.
thumbnail
string 
thumbnail
required
The product's thumbnail.
width
number 
width
required
The product's width.
weight
number 
weight
required
The product's weight.
height
number 
height
required
The product's height.
origin_country
string 
origin_country
required
The product's origin country.
hs_code
string 
hs_code
required
The product's HS code.
mid_code
string 
mid_code
required
The product's MID code.
material
string 
material
required
The product's material.
collection_id
string 
collection_id
required
The ID of the collection that the product belongs to.
type_id
string 
type_id
required
The ID of the product's type.
images
array[object (AdminProductImage) {7}] 
required
The product's images.
discountable
boolean 
discountable
required
Whether discounts can be applied on the product.
external_id
string 
external_id
required
The ID of a product in an external system, such as an ERP or CMS.
deleted_at
string <date-time>
deleted_at
required
The date the product was deleted.
status
enum<string> 
required
The product's status.
Allowed values:
draftproposedpublishedrejected
deleted
object 
required
The deleted products' details.
object
string 
object
required
The name of the deleted objects.
Default:
product
deleted
boolean 
deleted
required
Whether the products were deleted.
ids
array[string]
required
The IDs of deleted products.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:10:32
Previous
Export Products
Next
Manage Variants in a Product
Built with