openapi: 3.2.0 info: title: Online Store Products API version: '1.0' description: Online Store API servers: - url: https://www.yoursite.com/api/v1 description: '' security: - X-AC-Auth-Token: [] tags: - name: Products paths: /inventory: parameters: [] get: summary: Get Inventory tags: - Products responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/inventory' operationId: get-inventory parameters: - schema: type: integer in: query name: product_id required: true - schema: type: integer in: query name: variant_inventory_id - schema: type: string in: query name: item_number - schema: type: string in: query name: gtin - schema: type: string in: query name: item_name description: 'Gets current inventory of specified item in query. ' requestBody: content: application/json: schema: description: '' type: object x-examples: example-1: product_id: 62 variant_inventory_id: null item_number: 60PY2DR item_name: 60PY2DR gtin: '' quantity: 20 properties: product_id: type: integer variant_inventory_id: type: integer item_number: type: string minLength: 1 item_name: type: string minLength: 1 gtin: type: string quantity: type: number required: - product_id - item_number - item_name - gtin - quantity examples: Example: value: product_id: 62 variant_inventory_id: 145 item_number: 60PY2DR item_name: 60PY2DR gtin: '' quantity: 20 /products: get: summary: Get Products tags: - Products responses: '200': description: OK content: application/json: schema: type: object properties: total_count: type: integer products: type: array items: $ref: '#/components/schemas/products' operationId: get-products description: Gets an array of products. post: summary: Create a Product operationId: post-products responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/products' tags: - Products description: Creates a product. requestBody: content: application/json: schema: description: '' type: object x-examples: example-1: id: 112 item_number: NCC-1701-C manufacturer_id: 0 manufacturer_part_number: '' primary_category_id: 47 product_status_id: 1 item_name: Not a Flame Thrower bullets: '' short_description: '' long_description_2: '' long_description_3: '' long_description_4: '' long_description_5: '' height: '' length: '' width: '' size_unit: In weight: 0 weight_unit: Lbs cost: 0 price: 55 retail: 56 minimum_quantity: 0 maximum_quantity: 0 is_spotlight_item: 0 quantity_on_hand: 20000 keywords: '' is_non_taxable: 0 is_shipped_individually: 0 is_hidden: 0 sort_order: 0 e_product_type: NotAnEProduct e_product_url: '' e_product_password: '' e_product_verification_link_expiration: 0 e_product_email: '' e_product_allow_multiple_deliveries: 0 warehouse_id: 5 call_for_shipping: 0 quickbooks_item_id: '' call_for_pricing: 0 rate_adjustment_type: AutoCalculation meta_description: '' page_title: '' use_tabs: false related_name: '' override_theme_use_tabs: false long_description_tab_name_1: '' long_description_tab_name_2: '' long_description_tab_name_3: '' long_description_tab_name_4: '' long_description_tab_name_5: '' long_description_1:

this is the description

is_non_shipping_item: false e_product_delivery_action: null use_variant_inventory: false is_featured_item: false long_description_external_url_1: '' long_description_external_url_2: '' long_description_external_url_3: '' long_description_external_url_4: '' long_description_external_url_5: '' bullets_external_url: '' custom_flag_1: false custom_flag_2: false custom_flag_3: false custom_flag_4: false custom_flag_5: false url_rewrite: /not-a-flame-thrower.aspx is_kit: false is_child_product: true is_non_inventory: false is_discontinued: false eta_date: null quantity_on_order: 0 available_region_id: null call_for_shipping_on_whole_order: false break_out_shipping: false shipping_classification_code: '' exclude_parent_from_display: true drop_ship: true no_price_mask: '' starting_quantity: 1 tax_code: '' use_map_pricing: false last_item_number: '' has_visible_variants: false product_rating_dimension_group_override_id: null average_review_rating: null review_count: null exclude_children_from_display: false use_pricing_from_parent: false low_stock_warning_threshold: null enable_low_stock_warning: false do_not_discount: false head_tags: '' handling_fee: 0 custom_upsell_url: '' e_product_serial_number_file_path: '' hide_variant_surcharges: false quantity_increment: 1 gtin: '' add_to_cart_message: '' is_subscription_product: false subscription_frequency: null subscription_frequency_type: '' e_product_generic_username: '' e_product_generic_password: '' shipping_override: null insurance_cost: null exclude_from_commissions: false days_until_reorder_allowed: 0 force_separate_order: false approval_required: false in_stock_notification_email_template_id: 0 earns_points: false additional_points_earned: 0 allowed_variable_subscription_types: '' profile_id: null is_linked_product: false master_product_id: null do_not_send_review_request: false properties: item_number: type: string manufacturer_id: type: integer manufacturer_part_number: type: string primary_category_id: type: integer product_status_id: type: integer item_name: type: string bullets: type: string short_description: type: string long_description_2: type: string long_description_3: type: string long_description_4: type: string long_description_5: type: string height: type: string length: type: string width: type: string size_unit: type: string weight: type: number weight_unit: type: string cost: type: number price: type: number retail: type: number minimum_quantity: type: integer maximum_quantity: type: integer is_spotlight_item: type: integer quantity_on_hand: type: integer keywords: type: string is_non_taxable: type: integer is_shipped_individually: type: integer is_hidden: type: integer sort_order: type: integer e_product_type: type: string e_product_url: type: string e_product_password: type: string e_product_verification_link_expiration: type: integer e_product_email: type: string e_product_allow_multiple_deliveries: type: integer warehouse_id: type: integer call_for_shipping: type: integer quickbooks_item_id: type: string call_for_pricing: type: integer rate_adjustment_type: type: string meta_description: type: string page_title: type: string use_tabs: type: boolean related_name: type: string override_theme_use_tabs: type: boolean long_description_tab_name_1: type: string long_description_tab_name_2: type: string long_description_tab_name_3: type: string long_description_tab_name_4: type: string long_description_tab_name_5: type: string long_description_1: type: string is_non_shipping_item: type: boolean e_product_delivery_action: type: string use_variant_inventory: type: boolean is_featured_item: type: boolean long_description_external_url_1: type: string long_description_external_url_2: type: string long_description_external_url_3: type: string long_description_external_url_4: type: string long_description_external_url_5: type: string bullets_external_url: type: string custom_flag_1: type: boolean custom_flag_2: type: boolean custom_flag_3: type: boolean custom_flag_4: type: boolean custom_flag_5: type: boolean url_rewrite: type: string is_kit: type: boolean is_child_product: type: boolean is_non_inventory: type: boolean is_discontinued: type: boolean eta_date: type: string quantity_on_order: type: integer available_region_id: type: integer call_for_shipping_on_whole_order: type: boolean break_out_shipping: type: boolean shipping_classification_code: type: string exclude_parent_from_display: type: boolean drop_ship: type: boolean no_price_mask: type: string starting_quantity: type: integer tax_code: type: string use_map_pricing: type: boolean last_item_number: type: string has_visible_variants: type: boolean product_rating_dimension_group_override_id: type: integer average_review_rating: type: number review_count: type: integer exclude_children_from_display: type: boolean use_pricing_from_parent: type: boolean low_stock_warning_threshold: type: integer enable_low_stock_warning: type: boolean do_not_discount: type: boolean head_tags: type: string handling_fee: type: number custom_upsell_url: type: string e_product_serial_number_file_path: type: string hide_variant_surcharges: type: boolean quantity_increment: type: integer gtin: type: string add_to_cart_message: type: string is_subscription_product: type: boolean subscription_frequency: type: integer subscription_frequency_type: type: string e_product_generic_username: type: string e_product_generic_password: type: string shipping_override: type: number insurance_cost: type: number exclude_from_commissions: type: boolean days_until_reorder_allowed: type: integer force_separate_order: type: boolean approval_required: type: boolean in_stock_notification_email_template_id: type: integer earns_points: type: boolean additional_points_earned: type: integer allowed_variable_subscription_types: type: string profile_id: type: integer is_linked_product: type: boolean master_product_id: type: integer do_not_send_review_request: type: boolean pack_slip_sort_order: type: integer is_enable_variants_on_parent: type: boolean is_hide_children_on_parent: type: boolean cart_product_id: type: guid enabled_configurator: type: string material_code: type: string product_line_code: type: string ext_update_date: type: string additional_attributes: type: string shipper_hq_shipping_groups: type: string shipper_hq_dimensional_rule_groups: type: string shipper_hq_packing_boxes: type: string freight_class: type: string hs_code: type: string coo: type: string hts: type: string is_exempt_from_min_order_amount: type: boolean category_list: type: string required: - primary_category_id - product_status_id - item_name - price - long_description_tab_name_5 /products/{id}: parameters: - schema: type: integer name: id in: path required: true description: The ID of the `product` put: summary: Update a Product operationId: put-products-id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/products' tags: - Products description: Updates a product. requestBody: content: application/json: schema: $ref: '#/components/schemas/products' delete: summary: Delete a Product operationId: delete-products-id description: Deletes a product. tags: - Products responses: '200': description: OK '404': $ref: '#/components/responses/404' components: schemas: inventory: type: object properties: product_id: type: integer variant_inventory_id: type: integer item_number: type: string item_name: type: string gtin: type: string quantity: type: integer products: type: object properties: id: type: integer item_number: type: string manufacturer_id: type: integer manufacturer_part_number: type: string primary_category_id: type: integer product_status_id: type: integer item_name: type: string bullets: type: string short_description: type: string long_description_2: type: string long_description_3: type: string long_description_4: type: string long_description_5: type: string height: type: string length: type: string width: type: string size_unit: type: string weight: type: number weight_unit: type: string cost: type: number price: type: number retail: type: number minimum_quantity: type: integer maximum_quantity: type: integer is_spotlight_item: type: integer quantity_on_hand: type: integer keywords: type: string is_non_taxable: type: integer is_shipped_individually: type: integer is_hidden: type: integer sort_order: type: integer e_product_type: type: string e_product_url: type: string e_product_password: type: string e_product_verification_link_expiration: type: integer e_product_email: type: string e_product_allow_multiple_deliveries: type: integer warehouse_id: type: integer call_for_shipping: type: integer quickbooks_item_id: type: string call_for_pricing: type: integer rate_adjustment_type: type: string meta_description: type: string page_title: type: string use_tabs: type: boolean related_name: type: string override_theme_use_tabs: type: boolean long_description_tab_name_1: type: string long_description_tab_name_2: type: string long_description_tab_name_3: type: string long_description_tab_name_4: type: string long_description_tab_name_5: type: string long_description_1: type: string is_non_shipping_item: type: boolean e_product_delivery_action: type: string use_variant_inventory: type: boolean is_featured_item: type: boolean long_description_external_url_1: type: string long_description_external_url_2: type: string long_description_external_url_3: type: string long_description_external_url_4: type: string long_description_external_url_5: type: string bullets_external_url: type: string custom_flag_1: type: boolean custom_flag_2: type: boolean custom_flag_3: type: boolean custom_flag_4: type: boolean custom_flag_5: type: boolean created_at: type: string updated_at: type: string url_rewrite: type: string is_kit: type: boolean is_child_product: type: boolean is_non_inventory: type: boolean is_discontinued: type: boolean eta_date: type: string quantity_on_order: type: integer available_region_id: type: integer call_for_shipping_on_whole_order: type: boolean break_out_shipping: type: boolean shipping_classification_code: type: string exclude_parent_from_display: type: boolean drop_ship: type: boolean no_price_mask: type: string starting_quantity: type: integer tax_code: type: string use_map_pricing: type: boolean last_item_number: type: string has_visible_variants: type: boolean product_rating_dimension_group_override_id: type: integer average_review_rating: type: number review_count: type: integer exclude_children_from_display: type: boolean use_pricing_from_parent: type: boolean low_stock_warning_threshold: type: integer enable_low_stock_warning: type: boolean do_not_discount: type: boolean head_tags: type: string handling_fee: type: number custom_upsell_url: type: string e_product_serial_number_file_path: type: string hide_variant_surcharges: type: boolean quantity_increment: type: integer gtin: type: string add_to_cart_message: type: string is_subscription_product: type: boolean subscription_frequency: type: integer subscription_frequency_type: type: string e_product_generic_username: type: string e_product_generic_password: type: string shipping_override: type: number insurance_cost: type: number exclude_from_commissions: type: boolean days_until_reorder_allowed: type: integer force_separate_order: type: boolean approval_required: type: boolean in_stock_notification_email_template_id: type: integer inelligible_for_purchase_by_points: type: boolean earns_points: type: boolean additional_points_earned: type: integer allowed_variable_subscription_types: type: string profile_id: type: integer is_linked_product: type: boolean master_product_id: type: integer do_not_send_review_request: type: boolean pack_slip_sort_order: type: integer is_enable_variants_on_parent: type: boolean is_hide_children_on_parent: type: boolean cart_product_id: type: guid enabled_configurator: type: string material_code: type: string product_line_code: type: string ext_update_date: type: string additional_attributes: type: string shipper_hq_shipping_groups: type: string shipper_hq_dimensional_rule_groups: type: string shipper_hq_packing_boxes: type: string freight_class: type: string hs_code: type: string coo: type: string hts: type: string is_exempt_from_min_order_amount: type: boolean category_list: type: string variants: type: array items: $ref: '#/components/schemas/product_nested_variant' product_nested_variant: type: object properties: id: type: integer product_id: type: integer variant_group_id: type: integer description: type: string price_adjustment: type: integer price_adjustment_type: type: string sort_order: type: integer item_number_extension: type: string item_number_sort_order: type: integer is_hidden: type: boolean weight: type: number weight_type: type: string updated_at: type: string created_at: type: string is_default_selection: type: boolean swatch_file: type: string swatch_thumbnail: type: string swatch_thumbnail_color: type: string description: Accessible via the `?expand=` parameter or `/api/v1/products/{id}/{nested_resource}`. responses: '404': description: Resource Not Found content: application/json: schema: description: Not Found type: object x-examples: example-1: status_code: 404 message: Not Found details: No resource found properties: status_code: type: number message: type: string details: type: string examples: {} headers: {} securitySchemes: X-AC-Auth-Token: name: X-AC-Auth-Token type: apiKey in: header