## productsAdd **Type:** GraphQL mutations **Description:** Create a new product with pricing, taxonomy, and media. ### Arguments - name (String) - shortName (String) - slug (String) - categoryId (String) - type (String) - description (String) - barcodes (String) - unitPrice (Float) - salePrice (Float) - compareAtPrice (Float) - code (String) - costPrice (Float) - currency (String) - mpn (String) - gtin (String) - requireShipping (Boolean) - channels (String) - unlimitedQuantity (Boolean) - saleStart (Date) - saleEnd (Date) - maxPerOrder (Int) - maxPerCustomer (Int) - isAvailable (Boolean) - hideQuantity (Boolean) - customFieldsData (JSON) - attachment (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - attachmentMore (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - media (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - vendorId (String) - uom (String) - subUoms (JSON) - taxType (String) - taxCode (String) - sku (String) - externalUrl (String) - source (String) - status (String) - productOptions (JSON) - productVariants (JSON) - priceRange (JSON) - hasVariants (Boolean) - weight (Float) - weightUnit (String) - dimensions (JSON) - inventory (JSON) - seo (JSON) ### Response **Type:** Product **Description:** Product entity including variants, pricing, and metadata. #### Fields - _id (String) - name (String) - shortName (String) - slug (String) - status (String) - code (String) - type (String) - description (String) - barcodes (String) - unitPrice (Float) - salePrice (Float) - costPrice (Float) - currency (String) - categoryId (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - createdAt (Date) - updatedAt (Date) - publishedAt (Date) - createdBy (String) - updatedBy (String) - getTags (Tag) - tagIds (String) - attachment (Attachment) - attachmentMore (Attachment) - media (Attachment) - vendorId (String) - workspaceId (String) - uom (String) - subUoms (JSON) - category (ProductCategory) - vendor (Company) - taxType (String) - taxCode (String) - sku (String) - externalUrl (String) - source (String) - mpn (String) - gtin (String) - requireShipping (Boolean) - channels (String) - unlimitedQuantity (Boolean) - saleStart (Date) - saleEnd (Date) - maxPerOrder (Int) - maxPerCustomer (Int) - isAvailable (Boolean) - hideQuantity (Boolean) - productOptions (ProductOption) - productVariants (ProductVariant) - priceRange (PriceRange) - hasVariants (Boolean) - hasCatalogWarning (Boolean) - weight (Float) - weightUnit (String) - dimensions (ProductDimensions) - inventory (ProductInventory) - seo (ProductSEO) --- ## productsEdit **Type:** GraphQL mutations **Description:** Update an existing product by id. ### Arguments - _id (String) - name (String) - shortName (String) - slug (String) - categoryId (String) - type (String) - description (String) - barcodes (String) - unitPrice (Float) - salePrice (Float) - compareAtPrice (Float) - code (String) - costPrice (Float) - currency (String) - mpn (String) - gtin (String) - requireShipping (Boolean) - channels (String) - unlimitedQuantity (Boolean) - saleStart (Date) - saleEnd (Date) - maxPerOrder (Int) - maxPerCustomer (Int) - isAvailable (Boolean) - hideQuantity (Boolean) - customFieldsData (JSON) - attachment (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - attachmentMore (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - media (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - vendorId (String) - uom (String) - subUoms (JSON) - taxType (String) - taxCode (String) - sku (String) - externalUrl (String) - source (String) - status (String) - productOptions (JSON) - productVariants (JSON) - priceRange (JSON) - hasVariants (Boolean) - weight (Float) - weightUnit (String) - dimensions (JSON) - inventory (JSON) - seo (JSON) ### Response **Type:** Product **Description:** Product entity including variants, pricing, and metadata. #### Fields - _id (String) - name (String) - shortName (String) - slug (String) - status (String) - code (String) - type (String) - description (String) - barcodes (String) - unitPrice (Float) - salePrice (Float) - costPrice (Float) - currency (String) - categoryId (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - createdAt (Date) - updatedAt (Date) - publishedAt (Date) - createdBy (String) - updatedBy (String) - getTags (Tag) - tagIds (String) - attachment (Attachment) - attachmentMore (Attachment) - media (Attachment) - vendorId (String) - workspaceId (String) - uom (String) - subUoms (JSON) - category (ProductCategory) - vendor (Company) - taxType (String) - taxCode (String) - sku (String) - externalUrl (String) - source (String) - mpn (String) - gtin (String) - requireShipping (Boolean) - channels (String) - unlimitedQuantity (Boolean) - saleStart (Date) - saleEnd (Date) - maxPerOrder (Int) - maxPerCustomer (Int) - isAvailable (Boolean) - hideQuantity (Boolean) - productOptions (ProductOption) - productVariants (ProductVariant) - priceRange (PriceRange) - hasVariants (Boolean) - hasCatalogWarning (Boolean) - weight (Float) - weightUnit (String) - dimensions (ProductDimensions) - inventory (ProductInventory) - seo (ProductSEO) --- ## productsRemove **Type:** GraphQL mutations **Description:** Remove products by ids; returns status string. ### Arguments - productIds (String) ### Response **Type:** String --- ## productCategoriesAdd **Type:** GraphQL mutations **Description:** Create a product category. ### Arguments - name (String) - code (String) - description (String) - parentId (String) - slug (String) - attachment (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - status (String) - seo (JSON) ### Response **Type:** ProductCategory **Description:** Category (taxonomy) for products. #### Fields - _id (String) - name (String) - description (String) - parentId (String) - code (String) - order (String) - slug (String) - workspaceId (String) - attachment (Attachment) - status (String) - isRoot (Boolean) - productCount (Int) - seo (ProductSEO) - createdAt (Date) - updatedAt (Date) --- ## productCategoriesEdit **Type:** GraphQL mutations **Description:** Edit a product category by id. ### Arguments - _id (String) - name (String) - code (String) - description (String) - parentId (String) - slug (String) - attachment (AttachmentInput): undefined - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - status (String) - seo (JSON) ### Response **Type:** ProductCategory **Description:** Category (taxonomy) for products. #### Fields - _id (String) - name (String) - description (String) - parentId (String) - code (String) - order (String) - slug (String) - workspaceId (String) - attachment (Attachment) - status (String) - isRoot (Boolean) - productCount (Int) - seo (ProductSEO) - createdAt (Date) - updatedAt (Date) --- ## productCategoriesRemove **Type:** GraphQL mutations **Description:** Remove a product category by id. ### Arguments - _id (String) ### Response **Type:** JSON