{"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 buyers.","termsOfService":"https://support.convictional.com/terms-of-service","title":"Buyer 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"]}},"/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/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"},"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.Attribute":{"properties":{"value":{}},"type":"object"},"handler.Attributes":{"additionalProperties":{"$ref":"#/components/schemas/handler.Attribute"},"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.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"},"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.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"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true,"samples-enabled":true}}