{"openapi":"3.0.0","info":{"contact":{"email":"support@convictional.com","name":"Support","url":"https://support.convictional.com"},"description":"This API reference documents endpoints that are exclusive to sellers.","termsOfService":"https://support.convictional.com/terms-of-service","title":"Seller API","version":"v2022-03-03"},"paths":{"/buyer/orders":{"get":{"description":"Returns a list of orders on behalf of a buyer. These orders can contain multiple orders that relate to multiple sellers.","operationId":"getBuyerOrders","parameters":[{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"Return resources updated after a given time. Use RFC 3339 format.","in":"query","name":"updatedMin","schema":{"type":"string"}},{"description":"Return orders that are marked as fulfilled.","in":"query","name":"fulfilled","schema":{"type":"string"}},{"description":"Return orders that are marked as posted to the seller.","in":"query","name":"posted","schema":{"type":"string"}},{"description":"Return orders that are marked as billed/invoiced.","in":"query","name":"invoiced","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/orders.OrderResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List orders","tags":["Order"]},"post":{"description":"A buyer can create a new order. This order can be associated with multiple sellers and it will be split.","operationId":"postBuyerOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orders.OrderRequest"}}},"description":"The buyer and product details necessary to create an order in Convictional.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orders.OrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create order","tags":["Order"]}},"/buyer/orders/{order_id}":{"get":{"description":"Returns a single orders on behalf of a buyer. This order can contain multiple orders that relate to multiple sellers.","operationId":"getBuyerOrder","parameters":[{"description":"ID of the order to get","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/orders.OrderResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get order","tags":["Order"]},"patch":{"description":"A buyer can update order attributes and metafields on an order they created.","operationId":"patchBuyerOrderByID","parameters":[{"description":"ID of the order to update","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orders.OrderUpdate"}}},"description":"The buyer and product details necessary to update an order in Convictional.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/orders.OrderResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update order","tags":["Order"]}},"/buyer/orders/{order_id}/cancel":{"post":{"description":"Use this endpoint to cancel an entire order and it's associated seller orders.\nOrders can only be cancelled once. Any order can be cancelled, including flagged orders and unposted orders,\nas long as the order is not already fully cancelled or fully fulfilled.\nPartially fulfilled orders can only be cancelled if unfulfilledOnly=true is sent.\n\nWhen unfulfilledOnly=true is sent, order items that have already been fulfilled are not cancelled, and all\nunfulfilled order items are cancelled. If the order had no fulfillments, this endpoint behaves the same as when\nomitting the unfulfilledOnly flag. If the order had at least one fulfillment, then in addition to setting the\ncancelled status, order.shipped will be set to true and the order is now considered fully fulfilled. If an order\nitem has been partially - but not completely - fulfilled, then that order item will be cancelled and a new\nuncancelled order item will be created representing the quantity that had already been fulfilled.","operationId":"cancelBuyerOrder","parameters":[{"description":"ID of the order to cancel","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orders.OrderCancelRequest"}}},"description":"An object with cancellation settings","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/orders.OrderResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Cancel order","tags":["Order"]}},"/buyer/orders/{order_id}/seller-orders/{seller_order_id}/items/{seller_order_item_id}/cancel":{"post":{"description":"Cancel a single seller order item on an order. Order items are fully cancelled by default. Order items can be\npartially cancelled by using the newQuantity parameter. Note that doing a partial cancellation will cancel the\noriginal seller order item and create a new order item representing the uncancelled quantity. Fulfilled items\ncannot be cancelled.\n\n**Note**: 'Order item' in this context specifically refers to seller order items (found at `order.sellerOrders[].items[]`).\nThe top-level order items (found at `order.items[]`) are not modified by cancellation endpoints.","operationId":"cancelSellerOrderItem","parameters":[{"description":"ID of the order","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the seller order","in":"path","name":"seller_order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the seller order item to cancel","in":"path","name":"seller_order_item_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/buyer.CancelSellerOrderItemRequest"}}},"description":"An object with cancellation settings","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/orders.SellerOrderItemResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Cancel order item","tags":["Order"]}},"/buyer/orders/{order_id}/seller-orders/{seller_order_id}/items/{seller_order_item_id}/return":{"post":{"description":"An endpoint for creating a return for an order item.\nDoes not affect billing.","operationId":"postReturn","parameters":[{"description":"ID of the buyer order with the new return","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the seller order with the new return","in":"path","name":"seller_order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the seller order item id to return","in":"path","name":"seller_order_item_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/buyer.CreateReturnRequestBody"}}},"description":"An object containing return details for the item","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/buyer.ReturnResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create return","tags":["Order"]}},"/buyer/orders/{order_id}/seller-orders/{seller_order_id}/returns":{"get":{"description":"An endpoint for listing the returns on an order.","operationId":"listOrderReturnsForBuyer","parameters":[{"description":"ID of the buyer order to get returns for.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the seller order to get returns for.","in":"path","name":"seller_order_id","required":true,"schema":{"type":"string"}},{"description":"The page number of results to return. Note this is a zero-based index.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of results per page. Max is 250.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/buyer.ReturnResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List returns","tags":["Order"]}},"/buyer/orders/{order_id}/seller-orders/{seller_order_id}/returns/{return_id}":{"get":{"description":"An endpoint for getting a return on an order.","operationId":"getOrderReturnForBuyer","parameters":[{"description":"ID of the buyer order with the return","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the seller order with the return","in":"path","name":"seller_order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the return","in":"path","name":"return_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/buyer.ReturnResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get return","tags":["Order"]}},"/buyer/price-lists/{listID}":{"get":{"description":"An endpoint for getting a Price List.","operationId":"getPriceListForBuyer","parameters":[{"description":"Price List ID of the Price List to get","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/buyer.PriceList"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get price list","tags":["Price List"]}},"/buyer/price-lists/{listID}/entries":{"get":{"description":"An endpoint for getting all Price List Entries for a specific Price List assigned to a given Buyer.","operationId":"listBuyerPriceListEntries","parameters":[{"description":"Price List ID of the Price List Entries to get","in":"path","name":"listID","required":true,"schema":{"type":"string"}},{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"Return resources updated after a given time. Use RFC 3339 format.","in":"query","name":"updatedAfter","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/buyer.PriceListEntry"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List price list entries","tags":["Price List Entry"]}},"/buyer/price-lists/{listID}/variants/{variantID}":{"get":{"description":"An endpoint for getting a Price List Entry for a specific Price List and Variant.","operationId":"getPriceListEntryByVariantID","parameters":[{"description":"Price List ID of the Price List Entry to get","in":"path","name":"listID","required":true,"schema":{"type":"string"}},{"description":"Variant ID of the Price List Entry to get","in":"path","name":"variantID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/buyer.PriceListEntry"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get price list entry by variant ID","tags":["Price List Entry"]}},"/buyer/products":{"get":{"description":"Returns a list of products that the buyer has access to.","operationId":"getBuyerProducts","parameters":[{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"Return resources updated after a given time. Use RFC 3339 format.","in":"query","name":"updatedMin","schema":{"type":"string"}},{"description":"Gets all the products for a specific vendor. Company ID must be the string, unique identifier of a product. You can find this by using the `sellerCompanyId` property returned by the `/partners` endpoint.","in":"query","name":"companyId","schema":{"type":"string"}},{"description":"Performs a case in-sensitive, substring search of product titles.","in":"query","name":"title","schema":{"type":"string"}},{"description":"Performs a case in-sensitive, substring search of a product seller reference code.","in":"query","name":"productCode","schema":{"type":"string"}},{"description":"Filter based on a buyer product code that has been set on a product.","in":"query","name":"buyerProductCode","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/products.BuyerProductResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List products","tags":["Product"]}},"/buyer/products/{product_id}":{"get":{"description":"Returns a specific product that the buyer has access to based on the id provided.","operationId":"getBuyerProduct","parameters":[{"description":"ID of the product to get","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/products.BuyerProductResponse"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get product","tags":["Product"]},"patch":{"description":"Allows a buyer to update title, description, tags, and Google Product Category. This does not update the\nseller instance of the product.","operationId":"updateBuyerProduct","parameters":[{"description":"ID of the product to update","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/products.BuyerProductResponse"}}},"description":"Product to update","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/products.BuyerProductResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update product","tags":["Product"]}},"/buyer/products/{product_id}/images/{image_id}":{"delete":{"description":"Removes an image from the buyer instance of a product.","operationId":"deleteBuyerProductImage","parameters":[{"description":"ID of the product","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"ID of the image to delete","in":"path","name":"image_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/buyer.EmptyResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete product image","tags":["Product"]}},"/buyer/products/{product_id}/sync-merchandising":{"post":{"description":"Sync seller merchandising data to product. This will also force sync the product to the buyer if the integration supports it.","operationId":"syncBuyerProduct","parameters":[{"description":"ID of the product to update","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/buyer.EmptyResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Sync seller merchandising data to product. This will also force sync the product to the buyer if the integration supports it.","tags":["Product"]}},"/buyer/products/{product_id}/variants":{"get":{"description":"Returns a list of variants based on the product id provided.","operationId":"getBuyerProductVariants","parameters":[{"description":"ID of the product for which to get variants","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/products.BuyerVariantResponse"},"type":"array"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List variants","tags":["Variant"]}},"/buyer/products/{product_id}/variants/{variant_id}":{"get":{"description":"Returns a specific variant based on the variant and product id's provided.","operationId":"getBuyerProductVariantByID","parameters":[{"description":"ID of the product for which to get a variant","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"ID of the variant to retrieve","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/products.BuyerVariantResponse"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get variant","tags":["Variant"]},"patch":{"description":"Updates a variant by ID for the requesting buyer.","operationId":"updateBuyerProductVariant","parameters":[{"description":"ID of the product for which to update a variant","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"ID of the variant to update","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/products.BuyerVariantResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update variant","tags":["Variant"]}},"/orders":{"get":{"description":"An endpoint for getting orders.","operationId":"getOrders","parameters":[{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"Return orders that are marked as shipped.","in":"query","name":"shipped","schema":{"type":"boolean"}},{"description":"Return orders that are synced to the seller.","in":"query","name":"posted","schema":{"type":"boolean"}},{"description":"Return orders that are marked as billed/invoiced.","in":"query","name":"billed","schema":{"type":"boolean"}},{"description":"Return resources created after a given time. Use RFC 3339 format.","in":"query","name":"createdMin","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/seller.Order"},"type":"array"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List orders","tags":["Order"]}},"/orders/{order_id}":{"get":{"description":"An endpoint for getting an order.","operationId":"getOrderByID","parameters":[{"description":"ID of the order to get","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Order"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get order","tags":["Order"]},"patch":{"description":"An endpoint for partially updating orders.","operationId":"updateOrderByID","parameters":[{"description":"ID of the order to update","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.OrderUpdate"}}},"description":"The order fields to update","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Order"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update order","tags":["Order"]}},"/orders/{order_id}/cancel":{"post":{"description":"Use this endpoint to cancel an entire order. After an order is cancelled, order.hasCancellations=true\nand each order item will have orderItem.cancelled=true. Orders cannot be uncancelled afterwards. Any order can\nbe cancelled, including flagged orders and unposted orders, as long as the order is not already fully cancelled\nor fully fulfilled. Partially fulfilled orders can only be cancelled if unfulfilledOnly=true is sent.\n\nWhen unfulfilledOnly=true is sent, order items that have already been fulfilled are not cancelled, and all\nunfulfilled order items are cancelled. If the order had no fulfillments, this endpoint behaves the same as when\nomitting the unfulfilledOnly flag. If the order had at least one fulfillment, then in addition to setting the\ncancelled status, order.shipped will be set to true and the order is now considered fully fulfilled. If an order\nitem has been partially - but not completely - fulfilled, then that order item will be cancelled and a new\nuncancelled order item will be created representing the quantity that had already been fulfilled.","operationId":"cancelOrder","parameters":[{"description":"ID of the order to cancel","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.CancelOrderRequest"}}},"description":"An object with cancellation settings","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.Order"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Cancel order","tags":["Order"]}},"/orders/{order_id}/fulfillments":{"post":{"description":"An endpoint for creating fulfillments on orders. Order items that have been cancelled cannot be fulfilled. If the buyer requires tracking information, the fulfillment will be rejected, and not created.","operationId":"postFulfillment","parameters":[{"description":"ID of the order with the new fulfillment","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.OtherFulfillment"}}},"description":"An object containing fulfillment details","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.CreateFulfillmentResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create fulfillment","tags":["Order"]}},"/orders/{order_id}/invoices":{"post":{"description":"Creates an invoice for the given order ID for manual billing. Currently for taxes, we support only `GS` (Goods & Services Tax) and `SP` (State/Provincial Sales Tax) values for `Type`. Invoices are only able to be generated after the order has been shipped.","operationId":"invoiceOrder","parameters":[{"description":"ID of the order to invoice","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.GenerateInvoice"}}},"description":"An object with tax specific settings for the invoice","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.OrderInvoice"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create invoice","tags":["Order"]}},"/orders/{order_id}/items/{item_id}/cancel":{"post":{"description":"Cancel a single order item on an order. Order items are fully cancelled by default. Order items can be partially\ncancelled by using the newQuantity parameter. Note that doing a partial cancellation will cancel the original order\nitem and create a new order item representing the uncancelled quantity. Fulfilled items cannot be cancelled.","operationId":"cancelOrderItem","parameters":[{"description":"ID of the order","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the order item","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.CancelOrderItemRequest"}}},"description":"The request body","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.OrderItem"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Cancel order item","tags":["Order"]}},"/orders/{order_id}/returns":{"get":{"description":"An endpoint for listing the returns on an order.","operationId":"listOrderReturnsForSeller","parameters":[{"description":"ID of the buyer order to get returns for.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"The page number of results to return. Note this is a zero-based index.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of results per page. Max is 250.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/seller.ReturnResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List returns","tags":["Order"]}},"/orders/{order_id}/returns/{return_id}":{"get":{"description":"An endpoint for getting a return on an order.","operationId":"getOrderReturnForSeller","parameters":[{"description":"ID of the buyer order with the return","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the return","in":"path","name":"return_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.ReturnResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get return","tags":["Order"]}},"/orders/{order_id}/returns/{return_id}/accept":{"patch":{"description":"An endpoint that allows sellers to accept returns.","operationId":"acceptReturn","parameters":[{"description":"ID of the order","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the return to be accepted","in":"path","name":"return_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/returns.AcceptReturn"}}},"description":"The payload for accepting a return, includes the required Seller Code","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/seller.ReturnResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Accepts a return","tags":["Order"]}},"/orders/{order_id}/returns/{return_id}/complete":{"patch":{"description":"An endpoint that allows sellers to complete returns.","operationId":"completeReturn","parameters":[{"description":"ID of the order","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the return to be completed","in":"path","name":"return_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/seller.ReturnResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Completes a return","tags":["Order"]}},"/orders/{order_id}/returns/{return_id}/reject":{"patch":{"description":"An endpoint that allows sellers to reject returns.","operationId":"rejectReturn","parameters":[{"description":"ID of the order","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"ID of the return to be rejected","in":"path","name":"return_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/returns.RejectReturn"}}},"description":"The payload for rejecting a return","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/seller.ReturnResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Rejects a return","tags":["Order"]}},"/price-lists":{"get":{"description":"An endpoint for getting all Price List.","operationId":"getAllPriceLists","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/seller.PriceList"},"type":"array"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List price lists","tags":["Price List"]},"post":{"description":"An endpoint for creating a Price List.","operationId":"createPriceList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceListCreate"}}},"description":"The Price List fields to create","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceList"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create price list","tags":["Price List"]}},"/price-lists/{listID}":{"delete":{"description":"An endpoint for deleting a Price List.","operationId":"deletePriceList","parameters":[{"description":"Price List ID of the Price List to delete","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.DeleteResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete price list","tags":["Price List"]},"get":{"description":"An endpoint for getting a Price List.","operationId":"getPriceList","parameters":[{"description":"Price List ID of the Price List to get","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceList"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get price list","tags":["Price List"]},"patch":{"description":"An endpoint for updating a Price List.","operationId":"updatePriceList","parameters":[{"description":"Price List ID of the Price List to update","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceListUpdate"}}},"description":"The Price List fields to update","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceList"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update price list","tags":["Price List"]}},"/price-lists/{listID}/add-all-products":{"post":{"description":"An endpoint for adding all active products to a Price List.","operationId":"addAllVariantsToPriceList","parameters":[{"description":"Price List ID of the Price List to add products to","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceList"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Add all variants to price list","tags":["Price List"]}},"/price-lists/{listID}/csv":{"get":{"description":"An endpoint for exporting a Price List CSV.","operationId":"exportPriceListCSV","parameters":[{"description":"Price List ID to export","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"type":"integer"},"type":"array"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Export price list CSV","tags":["Price List"]},"post":{"description":"An endpoint for importing a Price List CSV.","operationId":"importPriceListCSV","parameters":[{"description":"Price List ID to import","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{"schema":{"items":{"$ref":"#/components/schemas/seller.PriceListEntry"},"type":"array"}}}},"401":{"description":"Unauthorized","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Import price list CSV","tags":["Price List"]}},"/price-lists/{listID}/csv/preview":{"post":{"description":"An endpoint for previewing a Price List CSV import.","operationId":"previewPriceListCSV","parameters":[{"description":"Price List ID to preview","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/pricing.PriceListCSVPreview"}}}},"401":{"description":"Unauthorized","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Preview price list CSV","tags":["Price List"]}},"/price-lists/{listID}/entries":{"get":{"description":"An endpoint for getting all Price List Entries for a specific Price List.","operationId":"listPriceListEntries","parameters":[{"description":"Price List ID of the Price List Entries to get","in":"path","name":"listID","required":true,"schema":{"type":"string"}},{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"Return resources updated after a given time. Use RFC 3339 format.","in":"query","name":"updatedAfter","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/seller.PriceListEntry"},"type":"array"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List price list entries","tags":["Price List Entry"]},"post":{"description":"An endpoint for creating a Price List Entry for a specific Price List.","operationId":"createPriceListEntry","parameters":[{"description":"Price List ID of the Price List Entry to create","in":"path","name":"listID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceListEntryCreate"}}},"description":"The Price List Entry fields to create","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceListEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create price list entry","tags":["Price List Entry"]}},"/price-lists/{listID}/entries/{entryID}":{"delete":{"description":"An endpoint for deleting a Price List Entry for a specific Price List.","operationId":"deletePriceListEntry","parameters":[{"description":"Price List ID of the Price List Entry to delete","in":"path","name":"listID","required":true,"schema":{"type":"string"}},{"description":"Price List Entry ID of the Price List Entry to delete","in":"path","name":"entryID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.DeleteResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete price list entry","tags":["Price List Entry"]},"patch":{"description":"An endpoint for updating a Price List Entry for a specific Price List.","operationId":"updatePriceListEntry","parameters":[{"description":"Price List ID of the Price List Entry to update","in":"path","name":"listID","required":true,"schema":{"type":"string"}},{"description":"Price List Entry ID of the Price List Entry to update","in":"path","name":"entryID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceListEntryUpdate"}}},"description":"The Price List Entry fields to update","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.PriceListEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update price list entry","tags":["Price List Entry"]}},"/products":{"get":{"description":"An endpoint to get products, can be used by buyers or sellers","operationId":"getProducts","parameters":[{"description":"The page number of results to return. Note this is a zero-based index.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of results per page. Max is 250.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"Filters products by title. This can either be an exact title or a title similar.","in":"query","name":"title","schema":{"type":"string"}},{"description":"Filters products by brand (e.g. product.vendor field values). Must be an exact match.","in":"query","name":"vendor","schema":{"type":"string"}},{"description":"Filters products by product code. This can either be an exact product code or a product code similar.","in":"query","name":"productCode","schema":{"type":"string"}},{"description":"Filter out products are active or not active. This field is not required.","in":"query","name":"active","schema":{"type":"boolean"}},{"description":"Filters products by seller company ID. Must be an exact match.","in":"query","name":"companyId","schema":{"type":"string"}},{"description":"Filters products by tags. This is comma delimited for multiple tags. It returns products that have at any of the tags. Must be an exact match. Sellers only.","in":"query","name":"tags","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/seller.BuyerProduct"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List products","tags":["Product"]},"post":{"description":"An endpoint for sellers to create new products.","operationId":"postProducts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Product"}}},"description":"All the fields in a product","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Product"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create product","tags":["Product"]}},"/products/{product_id}":{"delete":{"description":"An endpoint for deleting a product with the provided ID","operationId":"deleteProductByID","parameters":[{"description":"ID of the product to delete","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.DeleteProductOrVariantResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete product","tags":["Product"]},"get":{"description":"An endpoint for getting products.","operationId":"getProductByID","parameters":[{"description":"ID of the product to get","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.BuyerProduct"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get product","tags":["Product"]},"patch":{"description":"An endpoint for partially updating a product with the provided ID. New variants, images, and options can be created by omitting their respective _id fields.","operationId":"patchProductByID","parameters":[{"description":"ID of the product to update","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Product"}}},"description":"The request body","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Product"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update product","tags":["Product"]}},"/products/{product_id}/deselect":{"put":{"description":"Marks a specific product that the buyer has access to based on the id provided as deselected.","operationId":"deselectBuyerProduct","parameters":[{"description":"ID of the product to deselect","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.BuyerProduct"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Deselect product","tags":["Product"]}},"/products/{product_id}/images/{image_id}":{"delete":{"description":"An endpoint for deleting a product image","operationId":"deleteProductImageByID","parameters":[{"description":"ID of the product to be deleted from","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"ID of the image to be deleted","in":"path","name":"image_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.DeleteImageResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete image","tags":["Product"]}},"/products/{product_id}/select":{"put":{"description":"Marks a specific product that the buyer has access to based on the id provided as selected. We recommend you check the product `selectedAvailable` to the buyer before selecting it.","operationId":"selectBuyerProduct","parameters":[{"description":"ID of the product to select","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/seller.BuyerProduct"}},"type":"object"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Select product","tags":["Product"]}},"/products/{product_id}/validation-errors":{"get":{"description":"An endpoint for getting product validation errors.","operationId":"get-product-validation-errors","parameters":[{"description":"ID of the product to get","in":"path","name":"product_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/productvalidation.BuyerValidationError"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get product validation errors","tags":["Product"]}},"/products/{product_id}/variant/{variant_id}":{"delete":{"description":"An endpoint for deleting a product with the provided ID","operationId":"deleteVariantByID","parameters":[{"description":"ID of the product associated with the variant to delete","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"ID of the variant to delete","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.DeleteProductOrVariantResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete variant","tags":["Variant"]}},"/products/{product_id}/variants/{variant_id}":{"patch":{"description":"An endpoint for partially updating a product variant with the provided ID","operationId":"patchVariantByID","parameters":[{"description":"ID of the product to update","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"ID of the variant to update","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Variant"}}},"description":"The request body","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/seller.Variant"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update variant","tags":["Variant"]}},"/products/validation-rules":{"get":{"description":"An endpoint for getting all product validation ruleset.","operationId":"get-product-validation-rules","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/productvalidation.APIResponse"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get all product validation rulesets","tags":["Product"]}},"/products/validation-rules/{ruleset_id}":{"get":{"description":"An endpoint for getting a specified product validation ruleset.","operationId":"get-product-validation-rules-by-id","parameters":[{"description":"ID of the ruleset to get","in":"path","name":"ruleset_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/productvalidation.APIResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get product validation ruleset","tags":["Product"]}}},"servers":[{"url":"//api.convictional.com"}],"components":{"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"api.APIWrapper":{"properties":{"data":{},"error":{"items":{"$ref":"#/components/schemas/api.ErrorMessage"},"type":"array"},"hasMore":{"type":"boolean"},"next":{"type":"string"},"previous":{"type":"string"}},"type":"object"},"api.ErrorMessage":{"properties":{"message":{"type":"string"}},"type":"object"},"api.ErrorResponse":{"properties":{"error":{"type":"string"}},"type":"object"},"base.MgoMoney":{"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"type":"object"},"buyer.CancelSellerOrderItemRequest":{"properties":{"newQuantity":{"default":0,"description":"Allows partial item cancellation. The quantity of the item to remain uncancelled. Must be less than the original quantity.","example":1,"type":"integer"},"reason":{"description":"The reason for cancellation.","example":"Out of stock.","type":"string"}},"type":"object"},"buyer.CreateReturnRequestBody":{"properties":{"buyerCode":{"description":"The reference for the return in the buyer's system.","example":"abc123","type":"string"},"quantity":{"description":"The quantity to return for the line item.","example":1,"type":"integer"},"reason":{"description":"The reason for the return.","example":"Item was the wrong size","type":"string"}},"required":["buyerCode","quantity","reason"],"type":"object"},"buyer.Dimensions":{"properties":{"height":{"description":"A height measurement","example":14.5,"type":"number"},"length":{"description":"A length measurement","example":11,"type":"number"},"units":{"description":"The units of measurement. Options are cm or in.","example":"in","type":"string"},"width":{"description":"A width measurement","example":20,"type":"number"}},"type":"object"},"buyer.EmptyResponse":{"type":"object"},"buyer.PriceList":{"properties":{"buyerRetailCurrency":{"type":"string"},"companyId":{"type":"string"},"created":{"description":"timestamps","type":"string"},"dropshipMargin":{"type":"number"},"dropshipMarginType":{"type":"string"},"hasTieredPricingEnabled":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"quoteMinimumValue":{"$ref":"#/components/schemas/money.Money"},"retailCurrencyConversionRate":{"type":"number"},"retailPriceFormat":{"type":"string"},"sellerCurrency":{"type":"string"},"shouldAddNewProducts":{"type":"boolean"},"updated":{"type":"string"},"wholesaleMargin":{"type":"number"},"wholesaleMarginType":{"type":"string"}},"type":"object"},"buyer.PriceListEntry":{"properties":{"buyerRetailPrice":{"$ref":"#/components/schemas/money.Money"},"created":{"description":"timestamps","type":"string"},"dropshipPrice":{"$ref":"#/components/schemas/money.Money"},"id":{"type":"string"},"priceListId":{"type":"string"},"productId":{"type":"string"},"productTitle":{"type":"string"},"sellerRetailPrice":{"$ref":"#/components/schemas/money.Money"},"updated":{"type":"string"},"variant":{"$ref":"#/components/schemas/buyer.Variant"},"variantId":{"type":"string"},"wholesaleUnitPricingTiers":{"$ref":"#/components/schemas/pricing.WholesaleUnitPricingTiers"}},"type":"object"},"buyer.ReturnResponse":{"properties":{"acceptedAt":{"description":"The time at which the return was accepted by the seller.","type":"string"},"buyerCode":{"description":"The buyer's reference for the return.","type":"string"},"buyerCompanyObjectId":{"description":"The company object ID of the buyer for the return.","type":"string"},"buyerItemCode":{"description":"The buyer's reference for the item in the fulfillment.","type":"string"},"buyerOrderId":{"description":"The buyer's order ID for the return.","type":"string"},"cancelledAt":{"description":"The time at which the return was cancelled.","type":"string"},"cancelledBy":{"description":"The company who cancelled the return, either the buyer or the seller.","type":"string"},"completedAt":{"description":"The time at which the return was marked as completed by the seller.","type":"string"},"createdAt":{"type":"string"},"id":{"type":"string"},"orderId":{"description":"The seller's order ID for the return.","type":"string"},"orderItemId":{"description":"The order item ID for the return - refers to the order item ID from the seller order.","type":"string"},"quantity":{"description":"The quantity of the return.","type":"integer"},"reason":{"description":"The reason for why the buyer is requesting a return.","type":"string"},"rejectedAt":{"description":"The time at which the return was rejected by the seller.","type":"string"},"rejectionReason":{"description":"The reason why the return was rejected by the seller.","type":"string"},"sellerCode":{"description":"The seller's reference for the return.","type":"string"},"sellerCompanyObjectId":{"description":"The company object ID of the seller for the return.","type":"string"},"sellerItemCode":{"description":"The seller's reference for the item in the fulfillment.","type":"string"},"status":{"type":"string"},"syncedToBuyerAt":{"description":"The time at which the return was last synced to the buyer's platform.","type":"string"},"syncedToSellerAt":{"description":"The time at which the return was last synced to the seller's platform.","type":"string"},"updatedAt":{"type":"string"}},"type":"object"},"buyer.Variant":{"properties":{"_id":{"description":"The Convictional variant ID. Read only.","type":"string"},"Metafields":{"$ref":"#/components/schemas/handler.Metafields"},"attributes":{"$ref":"#/components/schemas/handler.Attributes"},"barcode":{"description":"The barcode of the variant.","type":"string"},"barcodeType":{"description":"The type of barcode. Options are upc, gtin-13, gtin-14, or ean-8. The value \"gtin\" is also valid but is deprecated and will be converted to \"gtin-13\".","type":"string"},"code":{"readOnly":true,"type":"string"},"dimensions":{"$ref":"#/components/schemas/buyer.Dimensions"},"id":{"description":"A legacy Convictional ID for this variant. Read only.","type":"number"},"images":{"description":"An array of images corresponding to this variant.","items":{"$ref":"#/components/schemas/buyer.VariantImage"},"type":"array"},"inventoryQuantity":{"description":"The amount of stock available.","type":"integer"},"option1":{"description":"The value for option 1.","type":"string"},"option2":{"description":"The value for option 2.","type":"string"},"option3":{"description":"The value for option 3.","type":"string"},"retailPrice":{"description":"The standard retail price for this SKU.","type":"number"},"skipCount":{"type":"boolean"},"sku":{"description":"The seller's unique SKU for this variant.","type":"string"},"title":{"description":"The title of the variant.","type":"string"},"weight":{"description":"The weight of the variant.","type":"number"},"weightUnits":{"description":"The units of weight. Options are g, kg, lb, oz, or t.","type":"string"}},"type":"object"},"buyer.VariantImage":{"properties":{"_id":{"description":"The Convictional image ID.","readOnly":true,"type":"string"},"src":{"description":"The url of the image. If the url matches an image url elsewhere on the product, all instances will be given the same image ID.","type":"string"}},"type":"object"},"handler.Address":{"properties":{"_id":{"description":"The address ID.","type":"string"},"addressOne":{"description":"Address line one.","example":"123 Main St","type":"string"},"addressTwo":{"description":"Address line two.","example":"Apt. 411","type":"string"},"city":{"description":"The city.","example":"Waterloo","type":"string"},"company":{"description":"The name of the organization receiving the fulfillment.","example":"My Business Inc.","type":"string"},"country":{"description":"The country.","example":"Canada","type":"string"},"name":{"description":"The name of the customer receiving the fulfillment.","example":"Jane Doe","type":"string"},"phoneNumber":{"description":"An associated phone number.","example":"1112223333","type":"string"},"state":{"description":"The state or province.","example":"Ontario","type":"string"},"type":{"description":"The type of address.","example":"shipping","type":"string"},"zip":{"description":"The zip code or postal code.","example":"A1A 1A1","type":"string"}},"type":"object"},"handler.Attribute":{"properties":{"value":{}},"type":"object"},"handler.Attributes":{"additionalProperties":{"$ref":"#/components/schemas/handler.Attribute"},"type":"object"},"handler.Custom":{"properties":{"key":{"description":"The key of this custom metafield","type":"string"},"type":{"description":"The type of value this contains","type":"string"},"value":{"description":"The value of this metafield","type":"string"}},"type":"object"},"handler.Metafield":{"description":"The key of this metafield.","properties":{"description":{"description":"Describes the purpose of the metafield.","type":"string"},"updated":{"description":"Time of last update.","format":"date-time","type":"string"},"value":{"description":"The value of this metafield.","type":"string"}},"type":"object"},"handler.Metafields":{"additionalProperties":{"$ref":"#/components/schemas/handler.NamespacedMetafields"},"type":"object"},"handler.NamespacedMetafields":{"additionalProperties":{"$ref":"#/components/schemas/handler.Metafield"},"description":"A namespace to which this key belongs. Should uniquely identify the owner of this key.","type":"object"},"localization.String":{"additionalProperties":{"type":"string"},"type":"object"},"models.Attribute":{"properties":{"value":{}},"type":"object"},"models.AttributeUpdates":{"additionalProperties":{"$ref":"#/components/schemas/models.Attribute"},"type":"object"},"models.GenerateInvoice":{"properties":{"taxes":{"description":"Taxes applied to the given invoice.","items":{"$ref":"#/components/schemas/models.TaxItem"},"type":"array"}},"type":"object"},"models.Metafield":{"properties":{"description":{"description":"Describes the purpose of the metafield","type":"string"},"updated":{"type":"string"},"value":{"description":"Value stored by the field","type":"string"}},"type":"object"},"models.Metafields":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/models.Metafield"},"type":"object"},"type":"object"},"models.OrderUpdate":{"properties":{"attributes":{"$ref":"#/components/schemas/models.AttributeUpdates"},"billed":{"type":"boolean"},"note":{"type":"string"}},"type":"object"},"models.OtherFulfillment":{"properties":{"carrier":{"description":"The carrier (tracking company) of the fulfillment.","example":"USPS","type":"string"},"id":{"description":"The ID of the fulfillment (randomly generated)","readOnly":true,"type":"string"},"items":{"description":"The line items being fulfilled by this fulfillment.","items":{"$ref":"#/components/schemas/models.OtherFulfillmentItem"},"minItems":1,"type":"array"},"trackingCode":{"description":"The tracking code for the fulfillment","example":"1Z204E380338943508","type":"string"},"trackingNumbers":{"description":"Deprecated. Use TrackingCode instead.","items":{"type":"string"},"type":"array"},"trackingUrls":{"description":"The tracking urls of the fulfillment.","items":{"type":"string"},"type":"array"}},"required":["items"],"type":"object"},"models.OtherFulfillmentItem":{"properties":{"id":{"description":"The line item ID (corresponds to the sellerItemCode on the order item).","example":"1","type":"string"},"quantity":{"description":"The amount shipped.","example":2,"type":"integer"}},"required":["id","quantity"],"type":"object"},"models.PerOrderFee":{"properties":{"appliedFee":{"$ref":"#/components/schemas/base.MgoMoney"}},"type":"object"},"models.TaxItem":{"properties":{"amount":{"description":"The amount of tax applied for this type of tax.","example":12.34,"type":"number"},"rate":{"type":"number"},"type":{"description":"The type of tax applied to order, currently `GS` and `SP` are supported.","enum":["GS","SP","CP","CS","FT","LT"],"example":"GS","type":"string"}},"type":"object"},"money.Money":{"type":"object"},"orders.AddressRequest":{"properties":{"addressOne":{"description":"Address line one.","example":"123 Main St","type":"string"},"addressTwo":{"description":"Address line two.","example":"Apt. 411","type":"string"},"city":{"description":"The city.","example":"Waterloo","type":"string"},"company":{"description":"The name of the organization receiving the fulfillment.","example":"My Business Inc.","type":"string"},"country":{"description":"The country.","example":"Canada","type":"string"},"name":{"description":"The name of the customer receiving the fulfillment.","example":"Jane Doe","type":"string"},"phoneNumber":{"description":"An associated phone number.","example":"1112223333","type":"string"},"state":{"description":"The state or province.","example":"Ontario","type":"string"},"zip":{"description":"The zip code or postal code.","example":"A1A 1A1","type":"string"}},"type":"object"},"orders.BuyerOrderItemResponse":{"properties":{"basePrice":{"type":"number"},"buyerReference":{"description":"A reference to an ID in the buyer's system corresponding to this order line item.","example":"order_321_item_413","type":"string"},"buyerVariantCode":{"description":"The buyer's variant code for this line item.","example":"buyer_code_1","type":"string"},"id":{"description":"ID of this buyer order item. Read only.","example":"573ce4433302f4bae7878333","type":"string"},"productId":{"description":"ID of the product to be fulfilled. Use the value from product.id returned by the GET /buyer/products endpoint.","example":"573ce4477702f4bae7878776","type":"string"},"quantity":{"description":"The quantity of this variant to be fulfilled.","example":2,"type":"integer"},"retailPrice":{"description":"The after tax retail price of a single unit of this line item. Used for packing slip generation.","example":12.99,"type":"number"},"sellerOrderId":{"description":"ID of the seller order fulfilling this line item. Read only.","example":"573ce4444402f4bae7878444","type":"string"},"sellerOrderItemId":{"description":"ID of the seller order item corresponding to this line item. Read only.","example":"573ce4455502f4bae7878555","type":"string"},"variantId":{"description":"ID of the variant to be fulfilled. Use the value from product.variants.id returned by the GET /buyer/products endpoint.","example":"573ce4477702f4bae7878777","type":"string"}},"type":"object"},"orders.FulfillmentItemResponse":{"properties":{"id":{"description":"ID of the fulfillment item.","example":"573ce1110002f4bae78111001","type":"string"},"orderItemId":{"description":"ID of the seller order item corresponding to the variant being fulfilled.","example":"573ce4455502f4bae7878555","type":"string"},"quantity":{"description":"The amount being fulfilled.","example":2,"type":"integer"}},"type":"object"},"orders.FulfillmentResponse":{"properties":{"carrier":{"description":"The shipping carrier.","example":"USPS","type":"string"},"created":{"description":"The time the seller order was created. Null if not set. Read only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"id":{"description":"ID of the fulfillment.","example":"573ce0000002f4bae7878000","type":"string"},"items":{"description":"The seller order items included in this fulfillment.","items":{"$ref":"#/components/schemas/orders.FulfillmentItemResponse"},"type":"array"},"posted":{"description":"Indicates that the marketplace has received the fulfillment information.","example":false,"type":"boolean"},"postedDate":{"description":"The timestamp when the fulfillment was posted. RFC 3339 format. Null if not set. Read only.","type":"string"},"trackingCode":{"description":"Tracking code provided by the carrier.","example":"1Z204E380338943508","type":"string"},"trackingUrls":{"description":"Tracking URLs provided by the carrier.","items":{"type":"string"},"type":"array"},"updated":{"description":"The time the seller order was last updated. Null if not set. Read only.","example":"2020-05-01T21:35:00.000Z","type":"string"}},"type":"object"},"orders.OrderAddressResponse":{"properties":{"addressOne":{"description":"Address line one.","example":"123 Main St","type":"string"},"addressTwo":{"description":"Address line two.","example":"Apt. 411","type":"string"},"city":{"description":"The city.","example":"Waterloo","type":"string"},"company":{"description":"The name of the organization receiving the fulfillment.","example":"My Business Inc.","type":"string"},"country":{"description":"The country.","example":"Canada","type":"string"},"name":{"description":"The name of the customer receiving the fulfillment.","example":"Jane Doe","type":"string"},"phoneNumber":{"description":"An associated phone number.","example":"1112223333","type":"string"},"state":{"description":"The state or province.","example":"Ontario","type":"string"},"zip":{"description":"The zip code or postal code.","example":"A1A 1A1","type":"string"}},"type":"object"},"orders.OrderAttributeRequest":{"properties":{"value":{}},"type":"object"},"orders.OrderAttributeResponse":{"properties":{"value":{}},"type":"object"},"orders.OrderAttributeUpdatesRequest":{"additionalProperties":{"$ref":"#/components/schemas/orders.OrderAttributeRequest"},"type":"object"},"orders.OrderAttributesRequest":{"additionalProperties":{"$ref":"#/components/schemas/orders.OrderAttributeRequest"},"type":"object"},"orders.OrderAttributesResponse":{"additionalProperties":{"$ref":"#/components/schemas/orders.OrderAttributeResponse"},"type":"object"},"orders.OrderCancelRequest":{"properties":{"reason":{"description":"The reason for cancellation.","example":"Out of stock.","type":"string"},"unfulfilledOnly":{"default":false,"description":"Only cancel unfulfilled line items, rather than the entire order.","example":false,"type":"boolean"}},"type":"object"},"orders.OrderItemRequest":{"properties":{"buyerReference":{"description":"A reference to an ID in the buyer's system corresponding to this order line item.","example":"order_321_item_413","type":"string"},"buyerVariantCode":{"example":"buyer_code_1","type":"string"},"quantity":{"description":"The quantity of this variant to be fulfilled.","example":2,"minimum":1,"type":"integer"},"retailPrice":{"description":"The after tax retail price of a single unit of this line item. Used for packing slip generation.","example":12.99,"type":"number"},"variantId":{"description":"ID of the variant to be fulfilled. Use the value from product.variants.id returned by the GET /buyer/products endpoint.","example":"573ce4477702f4bae7878777","type":"string"}},"required":["buyerReference","quantity","variantId"],"type":"object"},"orders.OrderRequest":{"properties":{"address":{"$ref":"#/components/schemas/orders.AddressRequest"},"attributes":{"$ref":"#/components/schemas/orders.OrderAttributesRequest"},"buyerReference":{"description":"A reference to an ID in your (the buyer's) system. The ID must be unique.","example":"order_abc123","type":"string"},"customerEmail":{"description":"The end customer's email address.","example":"example@test.com","type":"string"},"customerReference":{"description":"The customer-facing reference to the order in your (the buyer's) system.","example":"order_abc123","type":"string"},"isTest":{"type":"boolean"},"items":{"description":"The line items on the buyer order.","items":{"$ref":"#/components/schemas/orders.OrderItemRequest"},"type":"array"},"metafields":{"$ref":"#/components/schemas/models.Metafields"},"note":{"description":"Additional information that will be passed along to each vendor with this order.","type":"string"},"orderedDate":{"description":"The timestamp when the order was originally placed by the customer. Use RFC 3339 format. Null if not set.","example":"2020-06-25T19:00:00.000+00:00","type":"string"},"shippingMethods":{"description":"The shipping methods for the order.","items":{"$ref":"#/components/schemas/orders.ShippingMethodsRequest"},"type":"array"}},"required":["address","buyerReference","items","orderedDate"],"type":"object"},"orders.OrderResponse":{"properties":{"address":{"$ref":"#/components/schemas/orders.OrderAddressResponse"},"attributes":{"$ref":"#/components/schemas/orders.OrderAttributesResponse"},"buyerReference":{"description":"A reference to an ID in your (the buyer's) system. The ID must be unique.","example":"order_abc123","type":"string"},"created":{"description":"The time the buyer order was created. Null if not set. Read only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"customerEmail":{"description":"The end customer's email address.","example":"abc123@gmail.com","type":"string"},"customerReference":{"description":"The customer-facing reference to the order in your (the buyer's) system.","example":"order_abc123","type":"string"},"id":{"description":"ID of this buyer order. Read only.","example":"573ce4451e02f4bae78788aa","type":"string"},"isTest":{"description":"Indicates whether the order is a test order","type":"boolean"},"items":{"description":"The line items on the buyer order.","items":{"$ref":"#/components/schemas/orders.BuyerOrderItemResponse"},"type":"array"},"itemsNotAccepted":{"description":"The line items that have not been accepted on the buyer order. This is only valid for companies with partial orders enabled.","items":{"$ref":"#/components/schemas/orders.BuyerOrderItemResponse"},"type":"array"},"metafields":{"$ref":"#/components/schemas/models.Metafields"},"note":{"description":"Additional information that will be passed along to each vendor with this order.","type":"string"},"orderedDate":{"description":"The timestamp when the order was originally placed by the customer. Use RFC 3339 format. Null if not set.","example":"2020-06-25T19:00:00.000+00:00","type":"string"},"quoteId":{"description":"The ID of a quote associated with this order.","type":"string"},"sellerOrders":{"description":"The seller orders fulfilling this buyer order. Read only.","items":{"$ref":"#/components/schemas/orders.SellerOrderResponse"},"type":"array"},"shippingMethods":{"description":"The shipping methods for the order.","items":{"$ref":"#/components/schemas/orders.OrderShippingMethodResponse"},"type":"array"},"updated":{"description":"The time the buyer order was last updated. Null if not set. Read only.","example":"2020-05-01T21:35:00.000Z","type":"string"}},"type":"object"},"orders.OrderShippingMethodResponse":{"properties":{"code":{"description":"The code of the shipping method.","example":"Standard Shipping","type":"string"},"price":{"$ref":"#/components/schemas/money.Money"},"title":{"description":"The title of the shipping method.","example":"Standard Shipping","type":"string"}},"type":"object"},"orders.OrderUpdate":{"properties":{"attributes":{"$ref":"#/components/schemas/orders.OrderAttributeUpdatesRequest"},"metafields":{"$ref":"#/components/schemas/models.Metafields"}},"type":"object"},"orders.SellerOrderItemResponse":{"properties":{"basePrice":{"description":"The wholesale price of the variant per unit, charged to the retailer/marketplace.","example":125.99,"type":"number"},"buyerReference":{"description":"Reference code for the order in the buyers system","type":"string"},"cancelled":{"description":"Indicates whether this order item has been cancelled.","example":true,"type":"boolean"},"cancelledBy":{"description":"Identifies the company that initiated the cancellation. Options: \"buyer\", \"seller\", or \"\" (blank only if item is not cancelled).","example":"buyer","type":"string"},"cancelledDate":{"description":"Time at which the order item was cancelled.","format":"date-time","type":"string"},"cancelledReason":{"description":"Reason that the order item was cancelled.","example":"Customer initiated cancellation.","type":"string"},"id":{"description":"ID of this seller order item.","example":"573ce4455502f4bae7878555","type":"string"},"quantity":{"description":"The quantity of this variant to be fulfilled.","example":2,"type":"integer"},"retailPrice":{"description":"The MSRP value of the order that was charged to the customer by the retail/marketplace.","example":199.99,"type":"number"},"sellerOrderId":{"description":"ID of the order as a whole in the sellers system","type":"string"},"sellerOrderItemId":{"description":"ID of the line item in the sellers system","type":"string"},"variantId":{"description":"ID of the variant to be fulfilled.","example":"573ce4499902f4bae7878999","type":"string"}},"type":"object"},"orders.SellerOrderResponse":{"properties":{"address":{"$ref":"#/components/schemas/orders.OrderAddressResponse"},"attributes":{"$ref":"#/components/schemas/orders.OrderAttributesResponse"},"baseCurrency":{"description":"The currency of the base prices on the order items.","example":"USD","type":"string"},"buyerOrderID":{"description":"ID of the buyer order this seller order belongs to.","example":"573ce4451e02f4bae78788aa","type":"string"},"buyerReference":{"description":"A reference to an ID in the buyer's system.","example":"order_abc123","type":"string"},"companyId":{"description":"The ID of the seller that fulfills this order.","example":"5a99ce11899999900f599111","type":"string"},"created":{"description":"The time the seller order was created. Null if not set. Read only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"customerReference":{"description":"The customer-facing reference to the order in your (the buyer's) system.","type":"string"},"flagged":{"description":"Flag to indicate that something went wrong with the order that needs to be manually resolved.","type":"boolean"},"flaggedAt":{"description":"Which stage of the order pipeline the order was flagged at. Used by reconciliation jobs.","type":"string"},"flaggedDate":{"description":"The timestamp when order was flagged.","type":"string"},"flaggedMessage":{"description":"Message containing details of the flagged order.","type":"string"},"fulfilled":{"description":"Indicates that the seller order has been completely fulfilled. This will be set to true once the fulfillments on the order satisfy all the line items on the order.","example":false,"type":"boolean"},"fulfilledDate":{"description":"The timestamp when the seller order was fulfilled. RFC 3339 format. Null if not set.","type":"string"},"fulfillments":{"description":"The fulfillments created by the seller to satisfy this order.","items":{"$ref":"#/components/schemas/orders.FulfillmentResponse"},"type":"array"},"hasCancellations":{"description":"Indicates that the sellerOrder contains cancellations","example":false,"type":"boolean"},"id":{"description":"ID of this seller order.","example":"5bbce4451e02f4bae78788bb","type":"string"},"invoiceId":{"description":"ID of the invoice corresponding to this seller order.","type":"string"},"invoiced":{"description":"Indicates that the marketplace has been invoiced for this seller order. If automatic invoicing is enabled, Convictional will invoice the order soon after it has been marked fulfilled.","example":false,"type":"boolean"},"invoicedDate":{"description":"The timestamp when the seller order was invoiced. RFC 3339 format. Null if not set.","type":"string"},"isTest":{"description":"Indicates whether the order is a test order","type":"boolean"},"items":{"description":"The line items on the seller order.","items":{"$ref":"#/components/schemas/orders.SellerOrderItemResponse"},"type":"array"},"packingSlipUrl":{"description":"URL of a packing slip for this seller order.","example":"https://convictional.com/123456","type":"string"},"posted":{"description":"Indicates that the seller has received the order.","example":false,"type":"boolean"},"postedDate":{"description":"The timestamp when the seller order was posted. RFC 3339 format. Null if not set.","type":"string"},"sellerReference":{"description":"A reference to an ID in the seller's system.","type":"string"},"updated":{"description":"The time the seller order was last updated. Null if not set. Read only.","example":"2020-05-01T21:35:00.000Z","type":"string"}},"type":"object"},"orders.ShippingMethodsRequest":{"properties":{"code":{"description":"The code of the shipping method.","example":"Standard Shipping","type":"string"},"price":{"$ref":"#/components/schemas/money.Money"},"title":{"description":"The title of the shipping method.","example":"Standard Shipping","type":"string"}},"type":"object"},"pricing.PriceListCSVPreview":{"properties":{"createdEntryCount":{"type":"integer"},"deletedEntryCount":{"type":"integer"},"updatedEntryCount":{"type":"integer"}},"type":"object"},"pricing.UnitPricingTier":{"properties":{"price":{"$ref":"#/components/schemas/money.Money"},"retailDiscount":{"type":"number"}},"type":"object"},"pricing.WholesaleUnitPricingTiers":{"additionalProperties":{"$ref":"#/components/schemas/pricing.UnitPricingTier"},"type":"object"},"products.AttributeResponse":{"properties":{"value":{"description":"The value of the attribute."}},"type":"object"},"products.AttributesResponse":{"additionalProperties":{"$ref":"#/components/schemas/products.AttributeResponse"},"description":"Attributes are to be used to store additional details regarding this resource that are not supported on the Convictional resource. The object keys are the names of the attributes.","type":"object"},"products.BuyerProductResponse":{"properties":{"attributes":{"$ref":"#/components/schemas/products.AttributesResponse"},"brand":{"description":"The brand of the product.","example":"Brand TM","type":"string"},"buyerProductCode":{"description":"A buyer identifier for the product","example":"PRODUCT0001","type":"string"},"companyId":{"description":"The ID of the company the product belongs to.","example":"5a99ce11899999900f599111","type":"string"},"created":{"description":"The time the product was created in Convictional's system.","example":"2020-05-01T19:35:00.000Z","type":"string"},"description":{"description":"The sanitized HTML body or description of the product.","example":"
This is a great product
","type":"string"},"descriptionTranslations":{"$ref":"#/components/schemas/localization.String"},"googleProductCategory":{"$ref":"#/components/schemas/products.GoogleProductCategoryResponse"},"id":{"description":"The ID of the product.","example":"5a88ce11899999900f599000","type":"string"},"images":{"description":"Array of image objects for this product.","items":{"$ref":"#/components/schemas/products.ImageResponse"},"type":"array"},"metafields":{"$ref":"#/components/schemas/models.Metafields"},"optionNames":{"description":"Array of variant option names for this product.","example":["Size"],"items":{"type":"string"},"type":"array"},"sellerReference":{"description":"A seller identifier for the product.","example":"PRODUCT0001","type":"string"},"seoTitle":{"description":"The SEO title of the product.","example":"My Product's SEO title'","type":"string"},"tags":{"description":"The tags associated with the product.","example":["footwear"],"items":{"type":"string"},"type":"array"},"title":{"description":"The title of the product.","example":"My Product","type":"string"},"titleTranslations":{"$ref":"#/components/schemas/localization.String"},"updated":{"description":"The time the product was last updated in Convictional's system.","example":"2020-05-01T21:35:00.000Z","type":"string"},"variants":{"description":"The variants belonging to the product.","items":{"$ref":"#/components/schemas/products.BuyerVariantResponse"},"type":"array"},"wholesalePricing":{"$ref":"#/components/schemas/products.WholesalePricingTierMinMaxResponse"}},"type":"object"},"products.BuyerVariantResponse":{"properties":{"attributes":{"$ref":"#/components/schemas/products.AttributesResponse"},"barcode":{"description":"The barcode of the product.","example":"036000291452","type":"string"},"barcodeType":{"description":"The type of barcode. Options are upc, gtin-13, gtin-14, or ean-8. The value \"gtin\" is also valid but is deprecated and will be converted to \"gtin-13\".","example":"upc","type":"string"},"baseCurrency":{"description":"The currency of the base price.","example":"CAD","type":"string"},"basePrice":{"description":"The wholesale price of the variant, charged to the retailer/marketplace.","example":210.99,"type":"number"},"buyerVariantCode":{"description":"A buyer identifier for the variant.","example":"VARIANT0001","type":"string"},"compareAtPrice":{"description":"The compare at price of the variant.","type":"string"},"created":{"description":"The time the variant was created in Convictional's system.","example":"2020-05-01T19:35:00.000Z","type":"string"},"dimensions":{"$ref":"#/components/schemas/products.VariantDimensionsResponse"},"id":{"description":"The ID of the variant.","example":"5a7bce11899999900f59915e","type":"string"},"inventoryAmount":{"description":"The amount of stock available.","example":99,"type":"integer"},"metafields":{"$ref":"#/components/schemas/models.Metafields"},"options":{"description":"The option values for this variant, based on the available option names listed on the overall product.","items":{"$ref":"#/components/schemas/products.OptionResponse"},"type":"array"},"retailCurrency":{"description":"The currency of the retail price.","example":"CAD","type":"string"},"retailPrice":{"description":"The seller's suggested retail price for this variant.","example":279.99,"type":"number"},"skipCount":{"default":false,"description":"If true, inventory tracking for this variant is turned off.","type":"boolean"},"sku":{"description":"The SKU of the variant.","example":"variant-01","type":"string"},"title":{"description":"The title of the variant.","example":"My Variant","type":"string"},"updated":{"description":"The time the variant was last updated in Convictional's system.","example":"2020-05-01T21:35:00.000Z","type":"string"},"weight":{"description":"The weight of the variant.","example":1.5,"type":"number"},"weightUnits":{"description":"The units of weight. Options are g, kg, lb, oz, or t.","example":"lb","type":"string"}},"type":"object"},"products.GoogleProductCategoryResponse":{"description":"The Google Product Category this product belongs to. Please refer to [this reference](https://support.google.com/merchants/answer/6324436?hl=en) for more details.","properties":{"code":{"description":"The category code from the Google Product Taxonomy. If only the category code is provided, we will set the corresponding category name. If this product should not be categorized, set this value to 0 and category name to \"\".","type":"integer"},"name":{"description":"The category name from the Google Product Taxonomy. If only the category name is provided, we will set the corresponding category code. If this product should not be categorized, set this value to \"\" and category code to 0.","type":"string"}},"type":"object"},"products.ImageResponse":{"properties":{"id":{"description":"A unique ID corresponding to this image.","example":"573ce1110002f4bae78234567","type":"string"},"position":{"description":"The index of the image. This will determine the order that images appear in.","example":0,"type":"integer"},"source":{"description":"The URL for the image.","example":"https://example.url/1","type":"string"},"variantIds":{"description":"A list of variant IDs that this image is associated with, if any. Field is omitted if empty.","example":["573ce1110002f4bae78123456"],"items":{"type":"string"},"type":"array"}},"type":"object"},"products.OptionResponse":{"properties":{"name":{"description":"The name of the option. This must match one of the product option names.","example":"Size","type":"string"},"value":{"description":"The value of the option for a specific variant on the product.","example":"M","type":"string"}},"type":"object"},"products.VariantDimensionsResponse":{"properties":{"height":{"description":"A height measurement","example":14.5,"type":"number"},"length":{"description":"A length measurement","example":11,"type":"number"},"units":{"description":"The units of measurement. Options are cm or in.","example":"in","type":"string"},"width":{"description":"A width measurement","example":20,"type":"number"}},"type":"object"},"products.WholesalePricingTierMinMaxResponse":{"properties":{"max":{"$ref":"#/components/schemas/money.Money"},"min":{"$ref":"#/components/schemas/money.Money"}},"type":"object"},"productvalidation.APIResponse":{"properties":{"id":{"type":"string"},"productValidationRules":{"description":"Array of all field validations to be applied on products","items":{"$ref":"#/components/schemas/productvalidation.FieldValidationRules"},"type":"array"}},"required":["productValidationRules"],"type":"object"},"productvalidation.BuyerValidationError":{"properties":{"additionalInfo":{"description":"Additional information, only relevant for certain complex validation types (ex. uniqueness)"},"fieldPath":{"description":"The path to the field that failed validation.","example":"title","type":"string"},"message":{"description":"The error message","example":"length must be greater than 5 characters, but is 4","type":"string"},"type":{"description":"The type of validation that failed","example":"min","type":"string"}},"type":"object"},"productvalidation.FieldValidation":{"properties":{"condition":{"description":"Condition corresponding to the validation. The actual field type may vary depending on the validation type","example":"great title","type":"string"},"validation":{"description":"The type of validation that failed","example":"equals","type":"string"}},"required":["validation"],"type":"object"},"productvalidation.FieldValidationRules":{"properties":{"field":{"description":"Name of the field to be validated on","example":"title","type":"string"},"rules":{"description":"Array of validations to be applied on the specific field","items":{"$ref":"#/components/schemas/productvalidation.FieldValidation"},"type":"array"}},"required":["field","rules"],"type":"object"},"returns.AcceptReturn":{"properties":{"sellerCode":{"description":"The reference for the return in the seller's system","type":"string"}},"type":"object"},"returns.RejectReturn":{"properties":{"rejectionReason":{"type":"string"}},"type":"object"},"seller.BuyerProduct":{"properties":{"active":{"description":"Is this product active? Active products are visible to partners.","type":"boolean"},"attributes":{"$ref":"#/components/schemas/handler.Attributes"},"bodyHtml":{"description":"The HTML body. Input will be sanitized before saving.","example":"This is a great product
","type":"string"},"bodyHtmlTranslations":{"$ref":"#/components/schemas/localization.String"},"code":{"description":"The seller's unique code for this product. This cannot be updated after creation.","type":"string"},"companyId":{"description":"The legacy company ID of the seller. Read only.","readOnly":true,"type":"string"},"companyObjectId":{"readOnly":true,"type":"string"},"createdAt":{"description":"The date this product was created. Read only.","format":"date-time","readOnly":true,"type":"string"},"custom":{"items":{"$ref":"#/components/schemas/handler.Custom"},"readOnly":true,"type":"array"},"delisted":{"description":"Is this product delisted? Read only.","readOnly":true,"type":"boolean"},"delistedUpdated":{"format":"date-time","readOnly":true,"type":"string"},"googleProductCategory":{"$ref":"#/components/schemas/seller.GoogleProductCategory"},"id":{"description":"The Convictional product ID. Read only.","readOnly":true,"type":"string"},"images":{"description":"Images of the product. Must be accessible via public URL.","items":{"$ref":"#/components/schemas/seller.Image"},"type":"array"},"marginRangeMax":{"type":"number"},"marginRangeMin":{"type":"number"},"options":{"items":{"$ref":"#/components/schemas/seller.Option"},"type":"array"},"predictions":{"items":{"$ref":"#/components/schemas/seller.Prediction"},"type":"array"},"selected":{"type":"boolean"},"selectedAvailable":{"type":"boolean"},"selectedAvailableReason":{"type":"string"},"seoTitle":{"type":"string"},"synced":{"type":"boolean"},"tags":{"description":"Add tags to the product to make it easier for buyers to categorize.","example":["footwear"],"items":{"type":"string"},"type":"array"},"taxCode":{"readOnly":true,"type":"string"},"title":{"description":"The name of the product.","example":"My Product","type":"string"},"titleTranslations":{"$ref":"#/components/schemas/localization.String"},"type":{"description":"The type of the product. Deprecated.","example":"item","type":"string"},"updatedAt":{"description":"The date this product was last updated. Read only.","format":"date-time","readOnly":true,"type":"string"},"variants":{"items":{"$ref":"#/components/schemas/seller.BuyerVariant"},"type":"array"},"vendor":{"description":"The vendor of the product.","example":"Brand TM","type":"string"}},"type":"object"},"seller.BuyerVariant":{"properties":{"_id":{"description":"The Convictional variant ID. Read only.","type":"string"},"Metafields":{"$ref":"#/components/schemas/handler.Metafields"},"attributes":{"$ref":"#/components/schemas/handler.Attributes"},"barcode":{"description":"The barcode of the variant.","type":"string"},"barcodeType":{"description":"The type of barcode. Options are upc, gtin-13, gtin-14, or ean-8. The value \"gtin\" is also valid but is deprecated and will be converted to \"gtin-13\".","type":"string"},"baseCurrency":{"description":"Available to buyers only. The currency of basePrice. Read only.","type":"string"},"basePrice":{"description":"Available to buyers only. The wholesale cost of this variant. Read only.","type":"number"},"code":{"readOnly":true,"type":"string"},"dimensions":{"$ref":"#/components/schemas/seller.Dimensions"},"id":{"description":"A legacy Convictional ID for this variant. Read only.","type":"number"},"images":{"description":"An array of images corresponding to this variant.","items":{"$ref":"#/components/schemas/seller.VariantImage"},"type":"array"},"inventoryQuantity":{"description":"The amount of stock available.","type":"integer"},"marginAmount":{"description":"The Margin Amount of the Variant","type":"number"},"marginPercent":{"description":"The Margin Percentage of the Variant","type":"number"},"option1":{"description":"The value for option 1.","type":"string"},"option2":{"description":"The value for option 2.","type":"string"},"option3":{"description":"The value for option 3.","type":"string"},"partnerPrice":{"description":"Available to buyers only. Shows the MSRP set by the seller. Read only.","type":"number"},"retailCurrency":{"type":"string"},"retailPrice":{"description":"The standard retail price for this SKU.","type":"number"},"skipCount":{"type":"boolean"},"sku":{"description":"The seller's unique SKU for this variant.","type":"string"},"synced":{"type":"boolean"},"title":{"description":"The title of the variant.","type":"string"},"weight":{"description":"The weight of the variant.","type":"number"},"weightUnits":{"description":"The units of weight. Options are g, kg, lb, oz, or t.","type":"string"}},"type":"object"},"seller.CancelOrderItemRequest":{"properties":{"newQuantity":{"default":0,"description":"Allows partial item cancellation. The quantity of the item to remain uncancelled. Must be greater or equal to the fulfilled quantity and less than the total item quantity.","example":1,"type":"integer"},"reason":{"description":"The reason for cancellation.","example":"Out of stock.","type":"string"}},"type":"object"},"seller.CancelOrderRequest":{"properties":{"reason":{"description":"The reason for cancelling the order","type":"string"},"unfulfilledOnly":{"description":"If true, cancels only the unfulfilled line items rather than the entire order","type":"boolean"}},"type":"object"},"seller.CreateFulfillmentResponse":{"properties":{"id":{"type":"string"}},"type":"object"},"seller.DeleteImageResponse":{"type":"object"},"seller.DeleteProductOrVariantResponse":{"properties":{"deleted":{"description":"ID of deleted product for logging on the client side.","type":"string"}},"type":"object"},"seller.DeleteResponse":{"type":"object"},"seller.Dimensions":{"properties":{"height":{"description":"A height measurement","example":14.5,"type":"number"},"length":{"description":"A length measurement","example":11,"type":"number"},"units":{"description":"The units of measurement. Options are cm or in.","example":"in","type":"string"},"width":{"description":"A width measurement","example":20,"type":"number"}},"type":"object"},"seller.Fulfillment":{"properties":{"_id":{"description":"The ID of the fulfillment.","example":"573ce4451e02f4bae78788aa","type":"string"},"buyerFulfillmentCode":{"description":"The buyer's specific code for this fulfillment.","example":"abc123","type":"string"},"carrier":{"description":"The shipping carrier","example":"USPS","type":"string"},"created":{"description":"The time the fulfillment was created.","example":"2020-05-01T19:35:00.000Z","type":"string"},"custom":{"description":"Custom fields for this fulfillment.","items":{"$ref":"#/components/schemas/handler.Custom"},"type":"array"},"items":{"description":"An array of items belonging to this fulfillment.","items":{"$ref":"#/components/schemas/seller.FulfillmentItem"},"type":"array"},"posted":{"description":"Indicates whether the fulfillment has been posted to the buyer's system.","example":true,"type":"boolean"},"postedDate":{"description":"The time the fulfillment was posted.","example":"2020-05-01T19:35:00.000Z","type":"string"},"sellerFulfillmentCode":{"description":"The seller's specific code for this fulfillment.","example":"abc123","type":"string"},"trackingCode":{"description":"Tracking code provided by the carrier.","example":"1Z204E380338943508","type":"string"},"trackingNumbers":{"description":"Deprecated. An array of tracking numbers related to this fulfillment. Use trackingCode instead.","example":["abc123"],"items":{"type":"string"},"type":"array"},"trackingUrls":{"description":"An array of tracking URLs.","items":{"type":"string"},"type":"array"},"updated":{"description":"The time the fulfillment was last updated.","example":"2020-05-01T19:35:00.000Z","type":"string"}},"type":"object"},"seller.FulfillmentItem":{"properties":{"_id":{"description":"The ID of the fulfillment item.","example":"6023f23334ca2118255da096","type":"string"},"barcode":{"description":"The barcode of the item.","example":"72527273070","type":"string"},"barcodeType":{"description":"The type of barcode number.","example":"upc","type":"string"},"buyerItemCode":{"description":"The buyer's specific code for this order item.","example":"abc123","type":"string"},"buyerProductCode":{"description":"The buyer's specific code for this product.","example":"abc123","type":"string"},"buyerVariantCode":{"description":"The buyer's specific code for this variant.","example":"abc123","type":"string"},"custom":{"description":"Custom fields for this order item.","items":{"$ref":"#/components/schemas/handler.Custom"},"type":"array"},"orderItemId":{"description":"The ID of the order item corresponding to this fulfillment item.","example":"6023f23334ca2118255da096","type":"string"},"price":{"description":"The price the buyer will pay the seller for this item.","example":50,"type":"number"},"quantity":{"description":"The quantity ordered for this line item.","example":2,"type":"integer"},"retailPrice":{"description":"The price the end customer has paid the buyer for this item.","example":79.99,"type":"number"},"sellerCode":{"description":"The seller's specific code for this fulfillment item.","example":"abc123","type":"string"},"sellerItemCode":{"description":"The seller's specific code for this order item.","example":"abc123","type":"string"},"sellerProductCode":{"description":"The seller's specific code for this product.","example":"abc123","type":"string"},"sellerVariantCode":{"description":"The seller's code for this variant.","example":"ABC123","type":"string"},"sku":{"description":"The SKU for this order item.","example":"abc123","type":"string"},"title":{"description":"The variant title of this order item.","example":"T-Shirt | White, Small","type":"string"},"type":{"description":"Deprecated.","type":"string"},"weight":{"description":"The weight of the order item","example":12,"type":"integer"}},"type":"object"},"seller.GoogleProductCategory":{"properties":{"code":{"description":"The category code from the Google Product Taxonomy. If only the category code is provided, we will set the corresponding category name. If this product should not be categorized, set this value to 0 and category name to \"\".","type":"integer"},"name":{"description":"The category name from the Google Product Taxonomy. If only the category name is provided, we will set the corresponding category code. If this product should not be categorized, set this value to \"\" and category code to 0.","type":"string"}},"type":"object"},"seller.Image":{"properties":{"_id":{"description":"The Convictional ID of the image.","type":"string"},"position":{"description":"The index of the image. This will determine the order that images appear in.","example":0,"type":"integer"},"src":{"description":"The URL of the image.","example":"https://mystore.com/product001-1.jpg","type":"string"},"variantIds":{"description":"The variant IDs associated with this image. Set this value via the variant.images field. Read only.","items":{"type":"string"},"type":"array"}},"type":"object"},"seller.Option":{"properties":{"_id":{"description":"The Convictional ID of the option","type":"string"},"name":{"description":"The name of the option","type":"string"},"position":{"description":"The position of the option","type":"integer"},"type":{"description":"The type of the option","readOnly":true,"type":"string"}},"type":"object"},"seller.Order":{"properties":{"_id":{"description":"The Convictional order ID. Read only.","example":"573ce4451e02f4bae78788aa","type":"string"},"billed":{"description":"Indicates if the order has been invoiced. Read Only.","example":true,"type":"boolean"},"billedDate":{"description":"The time the order was invoiced. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"billingAddress":{"$ref":"#/components/schemas/handler.Address"},"billingEndpoint":{"description":"The method used for billing this order.","example":"auto","type":"string"},"billingLocked":{"description":"An internal field indicating the order is in process of being billed.","example":false,"type":"boolean"},"buyerAttributes":{"$ref":"#/components/schemas/handler.Attributes"},"buyerCompanyId":{"description":"Legacy ID of the buyer company.","example":"company_abc123","type":"string"},"buyerCompanyObjectId":{"description":"The company ID of the buyer","example":"573ce4451e02f4bae78788aa","type":"string"},"buyerCreatedDate":{"description":"If set, indicates the date the order was created in the buyer's platform.","example":"2020-05-01T19:35:00.000Z","type":"string"},"buyerEmail":{"description":"Email for notifications.","example":"buyer@company.com","type":"string"},"buyerName":{"description":"Name of the buyer","type":"string"},"buyerOrderCode":{"description":"ID of the order in the buyer's system.","example":"order_abc123","type":"string"},"buyerOrderId":{"description":"ID of the Convictional Buyer Order","example":"573ce4451e02f4bae78788ff","type":"string"},"buyerOrderURL":{"description":"The URL of the order in the buyer's platform","type":"string"},"created":{"description":"The time the order was created. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"currency":{"description":"Currency code (e.g. CAD).","example":"USD","type":"string"},"custom":{"items":{"$ref":"#/components/schemas/handler.Custom"},"type":"array"},"customerEmail":{"description":"The end customer's email address.","example":"abc123@gmail.com","type":"string"},"customerOrderCode":{"description":"The customer-facing Order ID from the buyer's platform.","type":"string"},"fillTime":{"description":"The number of hours between the order being posted and the order being fulfilled. Null if not fulfilled.","example":12.5,"type":"number"},"flagged":{"description":"Indicates if the order has encountered an error during processing.","example":false,"type":"boolean"},"flaggedAt":{"description":"An internal field indicating the stage at which an error was encountered.","type":"string"},"flaggedDate":{"description":"The time that an error was encountered.","example":"2020-05-01T19:35:00.000Z","type":"string"},"flaggedMessage":{"description":"A message explaining the error that was encountered.","example":"An error occurred.","type":"string"},"fulfillments":{"description":"The fulfillments related to this order.","items":{"$ref":"#/components/schemas/seller.Fulfillment"},"type":"array"},"hasCancellations":{"description":"Indicates if any line items have been cancelled.","example":true,"type":"boolean"},"invoice":{"$ref":"#/components/schemas/seller.OrderInvoice"},"isCancelled":{"description":"Indicates if the order has been fully cancelled.","example":true,"type":"boolean"},"isReturned":{"description":"Indicates whether the order has been fully returned","type":"boolean"},"isSlaCompliant":{"description":"Indicates whether the order is SLA compliant. Null if not available.","type":"boolean"},"isTest":{"description":"Indicates whether the order is a test order","type":"boolean"},"items":{"description":"The line items on the order.","items":{"$ref":"#/components/schemas/seller.OrderItem"},"type":"array"},"note":{"description":"A note relating to the order.","example":"This order is ready to ship.","type":"string"},"orderFee":{"$ref":"#/components/schemas/models.PerOrderFee"},"packingSlip":{"description":"The URL to download a packing slip for this order.","example":"https://app.convictional.com/orders/1234/packingslip","type":"string"},"postInvoicesDate":{"description":"The time that posting the order to a payment system was attemped.","example":"2020-05-01T19:35:00.000Z","type":"string"},"postOrderLocked":{"description":"An internal field indicating the order is in process of being posted.","example":false,"type":"boolean"},"posted":{"description":"Indicates if the order has been posted to the seller's platform. Read Only.","example":true,"type":"boolean"},"postedDate":{"description":"The time the order was posted to the seller's platform. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"quoteId":{"description":"If this order started as a quote, it's the ID for that quote.","example":"622bc4c5951fb0f10dfc9712","type":"string"},"returns":{"description":"The returns related to this order.","items":{"$ref":"#/components/schemas/seller.ReturnResponse"},"type":"array"},"sellerAttributes":{"$ref":"#/components/schemas/handler.Attributes"},"sellerCompanyId":{"description":"Legacy ID of the seller company.","example":"company_def123","type":"string"},"sellerCompanyObjectId":{"description":"The company ID of the seller","example":"573ce4451e02f4bae78788aa","type":"string"},"sellerName":{"description":"Name of the seller","type":"string"},"sellerOrderCode":{"description":"ID of the order in the seller's system.","example":"order_def123","type":"string"},"sellerOrderURL":{"description":"The URL of the order in the seller's platform","type":"string"},"shipTime":{"description":"The number of hours between the order being created and the order being shipped.","example":0.5,"type":"number"},"shipped":{"description":"Indicates if the order has been fully shipped. Read Only.","example":true,"type":"boolean"},"shippedDate":{"description":"The time the order was fully shipped. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"shippingAddress":{"$ref":"#/components/schemas/handler.Address"},"shippingMethods":{"description":"The shipping methods available for this order.","items":{"$ref":"#/components/schemas/orders.OrderShippingMethodResponse"},"type":"array"},"taxStatus":{"description":"Current state of tax for an order (pending, calculated, unavailable, missingBillingAddress, and notRequired are valid)","type":"string"},"taxedAt":{"description":"Date at which the tax was applied","example":"2020-05-01T19:35:00.000Z","type":"string"},"taxes":{"description":"The line items on the order.","items":{"$ref":"#/components/schemas/models.TaxItem"},"type":"array"},"totalPrice":{"description":"Total price the buyer pays the seller for the order.","type":"number"},"totalRetailPrice":{"description":"Total price the end-customer pays the buyer for the order.","type":"number"},"updated":{"description":"The time the order was updated. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"}},"type":"object"},"seller.OrderInvoice":{"properties":{"_id":{"description":"The Convictional invoice ID. Read only.","example":"573ce4451e02f4bae78788aa","type":"string"},"EDISent":{"description":"Indicates if the EDI (810) document has been sent.","example":true,"type":"boolean"},"amountPaid":{"description":"Amount paid on the inoice.","example":0,"type":"number"},"amountRemaining":{"description":"The amount which has not yet been paid.","example":23.45,"type":"number"},"amountTotal":{"description":"The total amount of the invoice.","example":123.45,"type":"number"},"applicationFee":{"description":"Application Fee of the invoice.","example":0,"type":"number"},"buyerCode":{"description":"Buyer's specific code for the invoice.","example":"7101Z","type":"string"},"buyerCompanyObjectId":{"description":"Convictional ID for the Buyer Company. Read Only.","example":"573ce4451e02f4bae78788aa","type":"string"},"buyerId":{"description":"ID of the buyer company. Read Only.","example":"company_abc123","type":"string"},"created":{"description":"The time the invoice was created. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"currency":{"description":"Currency code (e.g. CAD).","example":"USD","type":"string"},"custom":{"items":{"$ref":"#/components/schemas/handler.Custom"},"type":"array"},"download":{"description":"Download link to the invoice from integrations we utilize, like Stripe","example":"https://pay.stripe.com/invoice/acct_XXXX...","type":"string"},"dueDate":{"description":"The date the invoice is due.","example":"2020-05-01T19:35:00.000Z","type":"string"},"errorDate":{"description":"The date that the most recent error happened on","example":"2020-05-01T19:35:00.000Z","type":"string"},"finalized":{"description":"Indicates whether the invoice has been finalized.","example":true,"type":"boolean"},"finalizedDate":{"description":"The date that this invoice was finalized on","example":"2020-05-01T19:35:00.000Z","type":"string"},"hostedURL":{"description":"A URL to the version of the invoice hosted by the seller's payment platform.","type":"string"},"items":{"description":"The line items on the order.","items":{"$ref":"#/components/schemas/seller.OrderInvoiceItem"},"type":"array"},"metafields":{"$ref":"#/components/schemas/handler.Metafields"},"notified":{"description":"Notification flag.","example":false,"type":"boolean"},"notifiedDate":{"description":"The time the notification flag was set.","example":"2020-05-01T19:35:00.000Z","type":"string"},"paid":{"description":"Flag if the invoice was paid.","example":false,"type":"boolean"},"paidDate":{"description":"The time the invoice was paid.","example":"2020-05-01T19:35:00.000Z","type":"string"},"posted":{"description":"Indicates if the invoice has been posted to the buyer's platform.","example":true,"type":"boolean"},"postedDate":{"description":"The date that this invoice was posted","example":"2020-05-01T19:35:00.000Z","type":"string"},"sellerCode":{"description":"Seller's specific code for the invoice.","example":"ABC123","type":"string"},"sellerCompanyObjectId":{"description":"Convictional ID for the Seller Company. Read Only.","example":"573ce4451e02f4bae78788aa","type":"string"},"sellerId":{"description":"ID of the seller company. Read Only.","example":"company_def123","type":"string"},"source":{"description":"Source of the invoice.","example":"stripe","type":"string"},"sourceId":{"description":"ID from the source of invoice.","example":"in_573ce4451e02f4bae78788aa","type":"string"},"state":{"description":"The current state of the invoice","example":"draft","type":"string"},"taxes":{"description":"The tax items on the order.","items":{"$ref":"#/components/schemas/seller.OrderInvoiceTaxItem"},"type":"array"},"updated":{"description":"The time the invoice was updated. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"}},"type":"object"},"seller.OrderInvoiceItem":{"properties":{"_id":{"description":"ID of the item for the invoice.","example":"6023f23334ca2118255da096","type":"string"},"amountCents":{"description":"The amount of referenced item, in cents.","example":1600,"type":"integer"},"reference":{"description":"What this item is refenced from.","example":"order","type":"string"},"referenceId":{"description":"Referenced type Convictional ID. Read Only.","example":"6023f23334ca2118255da096","type":"string"}},"type":"object"},"seller.OrderInvoiceTaxItem":{"properties":{"amount":{"description":"The amount of tax applied for this type of tax.","example":12.34,"type":"number"},"rate":{"description":"The percentage of tax applied for this type of tax.","example":0.05,"type":"number"},"type":{"description":"The type of tax applied to order, currently `GS` and `SP` are supported.","example":"GS","type":"string"}},"type":"object"},"seller.OrderItem":{"properties":{"_id":{"description":"The Convictional order item ID.","example":"6023f23334ca2118255da096","type":"string"},"barcode":{"description":"The barcode of the item.","example":"72527273070","type":"string"},"barcodeType":{"description":"The type of barcode number.","example":"upc","type":"string"},"buyerAttributes":{"$ref":"#/components/schemas/handler.Attributes"},"buyerItemCode":{"description":"The buyer's specific code for this order item.","example":"abc123","type":"string"},"buyerProductCode":{"description":"The buyer's specific code for this product.","example":"abc123","type":"string"},"buyerVariantCode":{"description":"The buyer's specific code for this variant.","example":"abc123","type":"string"},"cancelled":{"description":"Indicates if this line item has been cancelled.","example":false,"type":"boolean"},"cancelledBy":{"description":"Identifies the company that initiated the cancellation. Options: \"buyer\", \"seller\", or \"\" (blank only if item is not cancelled).","example":"seller","type":"string"},"cancelledDate":{"description":"The time the item was cancelled. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"cancelledReason":{"description":"The reason for the cancellation.","example":"Out of stock","type":"string"},"custom":{"description":"Custom fields for this order item.","items":{"$ref":"#/components/schemas/handler.Custom"},"type":"array"},"extendedPrice":{"description":"The extended price the buyer pays the seller for this item, quantity multiplied by price.","type":"number"},"extendedRetailPrice":{"description":"The extended price the end-customer pays the buyer for this item, quantity multiplied by price.","type":"number"},"price":{"description":"Unit price the buyer will pay the seller for this item.","example":50,"type":"number"},"productId":{"description":"ID of the product to be fulfilled. Use the value from product.id returned by the GET /products endpoint.","example":"573ce4477702f4bae7878776","type":"string"},"quantity":{"description":"The quantity ordered for this line item.","example":2,"type":"integer"},"retailPrice":{"description":"Unit price the end customer has paid the buyer for this item.","example":79.99,"type":"number"},"sellerAttributes":{"$ref":"#/components/schemas/handler.Attributes"},"sellerItemCode":{"description":"The seller's specific code for this order item.","example":"abc123","type":"string"},"sellerProductCode":{"description":"The seller's specific code for this product.","example":"abc123","type":"string"},"sellerVariantCode":{"description":"The seller's code for this variant.","example":"ABC123","type":"string"},"sku":{"description":"The SKU for this order item.","example":"abc123","type":"string"},"title":{"description":"The variant title of this order item.","example":"T-Shirt | White, Small","type":"string"},"type":{"description":"Deprecated.","type":"string"},"weight":{"description":"The weight of the order item","example":12,"type":"integer"}},"type":"object"},"seller.Prediction":{"properties":{"_id":{"description":"The Convictional ID of the prediction.","type":"string"},"createdAt":{"description":"The date the prediction was created.","type":"string"},"subject":{"description":"The subject of the prediction.","type":"string"},"updatedAt":{"description":"The date the prediction was last updated.","type":"string"}},"type":"object"},"seller.PriceList":{"properties":{"buyerRetailCurrency":{"description":"Supported Currencies","enum":["CAD","USD","AUD","EUR","GBP"],"type":"string"},"companyId":{"description":"Internal Convictional ID for the Company this Price List belongs to","type":"string"},"created":{"description":"timestamps","type":"string"},"dropshipMargin":{"description":"Dropship discount you wish to offer your partners for the Variants within this price list when calculating their cost price","type":"number"},"dropshipMarginType":{"description":"Supported Margin Types. If set to \"percent\" margins are represented as a decimal, e.g. 0.1 = 10%","enum":["fixed","percent"],"type":"string"},"id":{"description":"Internal Convictional ID for this Price List","type":"string"},"name":{"description":"The name of this Price List","type":"string"},"quoteMinimumValue":{"$ref":"#/components/schemas/money.Money"},"retailCurrencyConversionRate":{"description":"Conversion rate from your currency to that of your partners","type":"number"},"retailPriceFormat":{"description":"Cent/penny amount appended to the end of the price for each entry","example":".99","type":"string"},"sellerCurrency":{"description":"Supported Currencies","enum":["CAD","USD","AUD","EUR","GBP"],"type":"string"},"shouldAddNewProducts":{"description":"Automatically sync new products to this price list","type":"boolean"},"shouldIgnoreAutomatedSyncs":{"description":"Ignore pricing updates from your platform when syncing to Convictional for any variants within this price list","type":"boolean"},"updated":{"type":"string"},"wholesaleMargin":{"description":"Wholesale discount you wish to offer your partners for the variants within this price list when calculating their cost price","type":"number"},"wholesaleMarginType":{"description":"Supported Margin Types. If set to \"percent\" margins are represented as a decimal, e.g. 0.1 = 10%","enum":["fixed","percent"],"type":"string"}},"type":"object"},"seller.PriceListCreate":{"properties":{"buyerRetailCurrency":{"description":"Supported Currencies","enum":["CAD","USD","AUD","EUR","GBP"],"type":"string"},"dropshipMargin":{"description":"Dropship discount you wish to offer your partners for the variants within this price list when calculating their cost price","type":"number"},"dropshipMarginType":{"description":"Supported Margin Types. If set to \"percent\" margins are represented as a decimal, e.g. 0.1 = 10%.","enum":["fixed","percent"],"type":"string"},"name":{"description":"The name of this Price List","type":"string"},"quoteMinimumValue":{"$ref":"#/components/schemas/money.Money"},"retailCurrencyConversionRate":{"description":"Conversion rate from your currency to that of your partners","type":"number"},"retailPriceFormat":{"description":"Cent/penny amount appended to the end of the price for each entry","type":"string"},"sellerCurrency":{"description":"Supported Currencies","enum":["CAD","USD","AUD","EUR","GBP"],"type":"string"},"shouldAddCurrentProducts":{"default":false,"description":"If true, sync existing products to this price list","type":"boolean"},"shouldAddNewProducts":{"default":false,"description":"if true, automatically sync new products to this price list","type":"boolean"},"shouldIgnoreAutomatedSyncs":{"default":false,"description":"If true, dropship and retail prices will not change based on live retail prices from the supplier","type":"boolean"},"wholesaleMargin":{"description":"Wholesale discount you wish to offer your partners for the variants within this price list when calculating their cost price","type":"number"},"wholesaleMarginType":{"description":"Supported Margin Types. If set to \"percent\" margins are represented as a decimal, e.g. 0.1 = 10%.","enum":["fixed","percent"],"type":"string"}},"type":"object"},"seller.PriceListEntry":{"properties":{"buyerRetailPrice":{"$ref":"#/components/schemas/money.Money"},"created":{"description":"timestamps","type":"string"},"defaultImageUrl":{"description":"The default image of the product","type":"string"},"dropshipPrice":{"$ref":"#/components/schemas/money.Money"},"id":{"description":"Internal Convictional ID for this Price List Entry","type":"string"},"priceListId":{"description":"Internal Convictional ID for the Price List associated to this Price List Entry","type":"string"},"productId":{"description":"Internal Convictional ID for the Product associated to this Price List Entry","type":"string"},"productTitle":{"description":"Title of the Product associated to this Price List Entry","type":"string"},"sellerRetailPrice":{"$ref":"#/components/schemas/money.Money"},"updated":{"type":"string"},"variant":{"$ref":"#/components/schemas/seller.Variant"},"variantId":{"description":"Internal Convictional ID for the Variant associated to this Price List Entry","type":"string"},"wholesaleUnitPricingTiers":{"$ref":"#/components/schemas/pricing.WholesaleUnitPricingTiers"}},"type":"object"},"seller.PriceListEntryCreate":{"properties":{"dropshipPrice":{"$ref":"#/components/schemas/money.Money"},"sellerRetailPrice":{"$ref":"#/components/schemas/money.Money"},"variantId":{"description":"Internal Convictional ID for the Variant associated to this Price List Entry","type":"string"},"wholesaleUnitPricingTiers":{"$ref":"#/components/schemas/pricing.WholesaleUnitPricingTiers"}},"type":"object"},"seller.PriceListEntryUpdate":{"properties":{"dropshipPrice":{"$ref":"#/components/schemas/money.Money"},"sellerRetailPrice":{"$ref":"#/components/schemas/money.Money"},"wholesaleUnitPricingTiers":{"$ref":"#/components/schemas/pricing.WholesaleUnitPricingTiers"}},"type":"object"},"seller.PriceListUpdate":{"properties":{"dropshipMargin":{"description":"Dropship discount you wish to offer your partners for the variants within this price list when calculating their cost price","type":"number"},"dropshipMarginType":{"description":"Supported Margin Types. If set to \"percent\" margins are represented as a decimal, e.g. 0.1 = 10%.","enum":["fixed","percent"],"type":"string"},"name":{"description":"The name of this Price List","type":"string"},"quoteMinimumValue":{"$ref":"#/components/schemas/money.Money"},"retailCurrencyConversionRate":{"description":"Cent/penny amount appended to the end of the price for each entry","type":"number"},"retailPriceFormat":{"description":"Cent/penny amount appended to the end of the price for each entry","type":"string"},"shouldAddNewProducts":{"default":false,"description":"If true, automatically syncs new products to this price list","type":"boolean"},"shouldIgnoreAutomatedSyncs":{"default":false,"description":"If true, dropship and retail prices will not change based on live retail prices from the supplier","type":"boolean"},"wholesaleMargin":{"description":"Wholesale discount you wish to offer your partners for the variants within this price list when calculating their cost price","type":"number"},"wholesaleMarginType":{"description":"Supported Margin Types. If set to \"percent\" margins are represented as a decimal, e.g. 0.1 = 10%.","enum":["fixed","percent"],"type":"string"}},"type":"object"},"seller.Product":{"properties":{"active":{"description":"Is this product active? Active products are visible to partners.","type":"boolean"},"attributes":{"$ref":"#/components/schemas/handler.Attributes"},"bodyHtml":{"description":"The HTML body. Input will be sanitized before saving.","example":"This is a great product
","type":"string"},"code":{"description":"The seller's unique code for this product. This cannot be updated after creation.","type":"string"},"companyId":{"description":"The legacy company ID of the seller. Read only.","readOnly":true,"type":"string"},"companyObjectId":{"readOnly":true,"type":"string"},"createdAt":{"description":"The date this product was created. Read only.","format":"date-time","readOnly":true,"type":"string"},"custom":{"items":{"$ref":"#/components/schemas/handler.Custom"},"readOnly":true,"type":"array"},"delisted":{"description":"Is this product delisted? Read only.","readOnly":true,"type":"boolean"},"delistedUpdated":{"format":"date-time","readOnly":true,"type":"string"},"googleProductCategory":{"$ref":"#/components/schemas/seller.GoogleProductCategory"},"id":{"description":"The Convictional product ID. Read only.","readOnly":true,"type":"string"},"images":{"description":"Images of the product. Must be accessible via public URL.","items":{"$ref":"#/components/schemas/seller.Image"},"type":"array"},"options":{"items":{"$ref":"#/components/schemas/seller.Option"},"type":"array"},"tags":{"description":"Add tags to the product to make it easier for buyers to categorize.","example":["footwear"],"items":{"type":"string"},"type":"array"},"taxCode":{"readOnly":true,"type":"string"},"title":{"description":"The name of the product.","example":"My Product","type":"string"},"type":{"description":"The type of the product. Deprecated.","example":"item","type":"string"},"updatedAt":{"description":"The date this product was last updated. Read only.","format":"date-time","readOnly":true,"type":"string"},"variants":{"description":"Include one variant per size, color, etc. If there are no variants then include a single entry to be the default.","items":{"$ref":"#/components/schemas/seller.Variant"},"type":"array"},"vendor":{"description":"The vendor of the product.","example":"Brand TM","type":"string"}},"type":"object"},"seller.ReturnResponse":{"properties":{"acceptedAt":{"description":"The time at which the return was accepted by the seller.","type":"string"},"buyerCode":{"description":"The buyer's reference for the return.","type":"string"},"buyerCompanyObjectId":{"description":"The company object ID of the buyer for the return.","type":"string"},"buyerItemCode":{"description":"The buyer's reference for the item in the fulfillment.","type":"string"},"buyerOrderId":{"description":"The buyer's order ID for the return.","type":"string"},"cancelledAt":{"description":"The time at which the return was cancelled.","type":"string"},"cancelledBy":{"description":"The company who cancelled the return, either the buyer or the seller.","type":"string"},"completedAt":{"description":"The time at which the return was marked as completed by the seller.","type":"string"},"createdAt":{"type":"string"},"id":{"type":"string"},"orderId":{"description":"The seller's order ID for the return.","type":"string"},"orderItemId":{"description":"The order item ID for the return - refers to the order item ID from the seller order.","type":"string"},"quantity":{"description":"The quantity of the return.","type":"integer"},"reason":{"description":"The reason for why the buyer is requesting a return.","type":"string"},"rejectedAt":{"description":"The time at which the return was rejected by the seller.","type":"string"},"rejectionReason":{"description":"The reason why the return was rejected by the seller.","type":"string"},"sellerCode":{"description":"The seller's reference for the return.","type":"string"},"sellerCompanyObjectId":{"description":"The company object ID of the seller for the return.","type":"string"},"sellerItemCode":{"description":"The seller's reference for the item in the fulfillment.","type":"string"},"status":{"type":"string"},"syncedToBuyerAt":{"description":"The time at which the return was last synced to the buyer's platform.","type":"string"},"syncedToSellerAt":{"description":"The time at which the return was last synced to the seller's platform.","type":"string"},"updatedAt":{"type":"string"}},"type":"object"},"seller.Variant":{"properties":{"_id":{"description":"The Convictional variant ID. Read only.","type":"string"},"Metafields":{"$ref":"#/components/schemas/handler.Metafields"},"attributes":{"$ref":"#/components/schemas/handler.Attributes"},"barcode":{"description":"The barcode of the variant.","type":"string"},"barcodeType":{"description":"The type of barcode. Options are upc, gtin-13, gtin-14, or ean-8. The value \"gtin\" is also valid but is deprecated and will be converted to \"gtin-13\".","type":"string"},"code":{"readOnly":true,"type":"string"},"dimensions":{"$ref":"#/components/schemas/seller.Dimensions"},"id":{"description":"A legacy Convictional ID for this variant. Read only.","type":"number"},"images":{"description":"An array of images corresponding to this variant.","items":{"$ref":"#/components/schemas/seller.VariantImage"},"type":"array"},"inventoryQuantity":{"description":"The amount of stock available.","type":"integer"},"option1":{"description":"The value for option 1.","type":"string"},"option2":{"description":"The value for option 2.","type":"string"},"option3":{"description":"The value for option 3.","type":"string"},"retailPrice":{"description":"The standard retail price for this SKU.","type":"number"},"skipCount":{"type":"boolean"},"sku":{"description":"The seller's unique SKU for this variant.","type":"string"},"title":{"description":"The title of the variant.","type":"string"},"weight":{"description":"The weight of the variant.","type":"number"},"weightUnits":{"description":"The units of weight. Options are g, kg, lb, oz, or t.","type":"string"}},"type":"object"},"seller.VariantImage":{"properties":{"_id":{"description":"The Convictional image ID.","readOnly":true,"type":"string"},"src":{"description":"The url of the image. If the url matches an image url elsewhere on the product, all instances will be given the same image ID.","type":"string"}},"type":"object"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true,"samples-enabled":true}}