{"openapi":"3.1.0","info":{"version":"2.0.0","title":"Levanta Creator API v2","description":"Authorize all requests with an API key in the Authorization header as the second token. E.g. Authorization -> \"Bearer {api_key}\"."},"externalDocs":{"url":"https://app.levanta.io/creator/api-docs"},"servers":[{"url":"https://app.levanta.io/api/creator/v2"}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{},"parameters":{}},"paths":{"/reports/conversions":{"get":{"operationId":"CreatorListConversionsV2","tags":["Reports"],"summary":"List Conversions","description":"List conversions within a date range [start, end]. Start date must be before end date and the date range must not be greater than 60 days","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"orderId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subid1","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subid2","in":"query"},{"schema":{"type":"string"},"required":false,"name":"clickid","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"start","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"end","in":"query"},{"schema":{"type":"string","enum":["all","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace with conversion level data (ex: walmart.com, shopify.com). This union is subject to expand as new marketplaces are added."},"required":true,"description":"Represents a Levanta marketplace with conversion level data (ex: walmart.com, shopify.com). This union is subject to expand as new marketplaces are added.","name":"marketplace","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"The cursor returned from the last request, if omitted the first page will be returned"},"required":false,"description":"The cursor returned from the last request, if omitted the first page will be returned","name":"cursor","in":"query"},{"schema":{"type":"number","minimum":1,"maximum":500,"default":100,"description":"The maximum number of items to return"},"required":false,"description":"The maximum number of items to return","name":"limit","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"conversions":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"subid1":{"type":"string"},"subid2":{"type":"string"},"sharedId":{"type":"string"},"clickid":{"type":"string"},"id":{"type":"string"},"orderId":{"type":"string"},"quantity":{"type":"number"},"sales":{"type":"string"},"commissionAmount":{"type":"string"},"marketplace":{"type":"string","enum":["walmart.com","shopify.com"]},"product":{"type":"object","properties":{"primaryId":{"type":"string"},"ids":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["ASIN","SKU","GTIN","Walmart Item ID","Variant ID"]},"value":{"type":"string"}},"required":["label","value"]}},"title":{"type":"string"}},"required":["primaryId","ids","title"]},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","PAID"],"description":"The status of the conversion.\n\n                    - PENDING: The conversion is pending approval.\n                    - APPROVED: The conversion was approved and due to be paid out.\n                    - REJECTED: The conversion was rejected.\n                    - PAID: The conversion has been paid out."}},"required":["date","id","orderId","quantity","sales","commissionAmount","marketplace","product","status"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["conversions","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/reports/conversions/updates":{"get":{"operationId":"CreatorListConversionsUpdates","tags":["Reports"],"summary":"List Conversion Updates","description":"List conversion updates within a date range [start, end]. Start date must be before end date and the date range must not be greater than 60 days","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"orderId","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subid1","in":"query"},{"schema":{"type":"string"},"required":false,"name":"subid2","in":"query"},{"schema":{"type":"string"},"required":false,"name":"clickid","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"start","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"end","in":"query"},{"schema":{"type":"string"},"required":false,"name":"conversionId","in":"query"},{"schema":{"type":"string","enum":["all","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace with conversion level data (ex: walmart.com, shopify.com). This union is subject to expand as new marketplaces are added."},"required":true,"description":"Represents a Levanta marketplace with conversion level data (ex: walmart.com, shopify.com). This union is subject to expand as new marketplaces are added.","name":"marketplace","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"The cursor returned from the last request, if omitted the first page will be returned"},"required":false,"description":"The cursor returned from the last request, if omitted the first page will be returned","name":"cursor","in":"query"},{"schema":{"type":"number","minimum":1,"maximum":500,"default":100,"description":"The maximum number of items to return"},"required":false,"description":"The maximum number of items to return","name":"limit","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"quantityDiff":{"type":"number"},"salesDiff":{"type":"string"},"commissionAmountDiff":{"type":"string"},"conversion":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"subid1":{"type":"string"},"subid2":{"type":"string"},"sharedId":{"type":"string"},"clickid":{"type":"string"},"id":{"type":"string"},"orderId":{"type":"string"},"quantity":{"type":"number"},"sales":{"type":"string"},"commissionAmount":{"type":"string"},"marketplace":{"type":"string","enum":["walmart.com","shopify.com"]},"product":{"type":"object","properties":{"primaryId":{"type":"string"},"ids":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["ASIN","SKU","GTIN","Walmart Item ID","Variant ID"]},"value":{"type":"string"}},"required":["label","value"]}},"title":{"type":"string"}},"required":["primaryId","ids","title"]},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","PAID"],"description":"The status of the conversion.\n\n                    - PENDING: The conversion is pending approval.\n                    - APPROVED: The conversion was approved and due to be paid out.\n                    - REJECTED: The conversion was rejected.\n                    - PAID: The conversion has been paid out."}},"required":["date","id","orderId","quantity","sales","commissionAmount","marketplace","product","status"]}},"required":["id","date","quantityDiff","salesDiff","commissionAmountDiff","conversion"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["updates","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/deals":{"get":{"operationId":"CreatorListDealsV2","tags":["Deals"],"summary":"List Deals","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","enum":["all","amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":true,"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added.","name":"marketplace","in":"query"},{"schema":{"type":"string","description":"Comma-delimited list of strings representing an array. Example: 1,2,3 equivalent to [1,2,3]"},"required":false,"description":"Comma-delimited list of strings representing an array. Example: 1,2,3 equivalent to [1,2,3]","name":"brand_ids","in":"query"},{"schema":{"type":"string","description":"Filter deals by the associated products' primary IDs. Example: 1234567890,1234567891"},"required":false,"description":"Filter deals by the associated products' primary IDs. Example: 1234567890,1234567891","name":"product_ids","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"starts_before","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"starts_after","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"ends_before","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":false,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"ends_after","in":"query"},{"schema":{"type":"number","minimum":1,"maximum":500,"default":100,"description":"The maximum number of items to return"},"required":false,"description":"The maximum number of items to return","name":"limit","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"The cursor returned from the last request, if omitted the first page will be returned"},"required":false,"description":"The cursor returned from the last request, if omitted the first page will be returned","name":"cursor","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deals":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["DEAL","CLIPPABLE_COUPON","PROMO_CODE","FLASH_DEAL"]},"productIds":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["ASIN","SKU","GTIN","Walmart Item ID","Variant ID"]},"value":{"type":"string"}},"required":["label","value"]}},"marketplace":{"type":"string","enum":["amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). This union is subject to expand as new marketplaces are added."},"title":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"endDate":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]},"fullPrice":{"type":"number","description":"The full price of the product before the deal discount"},"discountPrice":{"type":"number","description":"The price of the product after the deal discount"},"discountPercentage":{"type":"number","description":"The percentage discount of the product"},"verified":{"type":"boolean","description":"Whether the deal is verified by Levanta or seller-submitted."},"promoCode":{"type":["string","null"],"description":"The promo code for the deal (if applicable)"}},"required":["type","productIds","marketplace","title","startDate","endDate","currency","fullPrice","discountPrice","discountPercentage","verified","promoCode"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["deals","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/products":{"get":{"operationId":"CreatorListProductsV2","tags":["Products"],"summary":"List Products","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","enum":["all","amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":true,"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added.","name":"marketplace","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"Whether or not to only return products for brands that you have an active partnership with"},"required":false,"description":"Whether or not to only return products for brands that you have an active partnership with","name":"access","in":"query"},{"schema":{"type":"string","description":"Filter products by their primary ID"},"required":false,"description":"Filter products by their primary ID","name":"product_ids","in":"query"},{"schema":{"type":"string","description":"Filter products by the brand ID"},"required":false,"description":"Filter products by the brand ID","name":"brand_ids","in":"query"},{"schema":{"type":"number","minimum":1,"maximum":500,"default":100,"description":"The maximum number of items to return"},"required":false,"description":"The maximum number of items to return","name":"limit","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"The cursor returned from the last request, if omitted the first page will be returned"},"required":false,"description":"The cursor returned from the last request, if omitted the first page will be returned","name":"cursor","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"primaryId":{"type":"string"},"ids":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["ASIN","SKU","GTIN","Walmart Item ID","Variant ID"]},"value":{"type":"string"}},"required":["label","value"]}},"title":{"type":"string","description":"The title of the product"},"brandId":{"type":"string","description":"The ID of the brand the product is associated with"},"brandName":{"type":"string","description":"The name of the brand the product is associated with"},"image":{"type":"string"},"category":{"type":"string"},"price":{"type":"object","properties":{"currency":{"type":"string"},"value":{"type":"string"}},"required":["currency","value"]},"commission":{"type":"object","properties":{"sellerCommission":{"type":"string"},"marketplaceCommission":{"type":"string"},"totalCommission":{"type":"string"}},"required":["sellerCommission","marketplaceCommission","totalCommission"]},"deal":{"type":["object","null"],"properties":{"active":{"type":"boolean"},"type":{"type":"string","enum":["DEAL","CLIPPABLE_COUPON","PROMO_CODE","FLASH_DEAL"]},"discountPrice":{"type":"number","description":"The price of the product after the deal discount"},"discountPercentage":{"type":"number","description":"The percentage discount of the product"},"startDate":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"endDate":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"promoCode":{"type":["string","null"],"description":"The promo code for the deal (if applicable)"}},"required":["active","type","discountPrice","discountPercentage","startDate","endDate","promoCode"]},"availability":{"type":"string","enum":["IN_STOCK","OUT_OF_STOCK"]},"marketplace":{"type":"string","enum":["amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). This union is subject to expand as new marketplaces are added."},"access":{"type":"boolean"},"rating":{"type":["string","null"],"description":"Current rating of the product"},"ratingsTotal":{"type":["number","null"],"description":"Total number of ratings for this product"},"platformEpc":{"type":["string","null"],"description":"Earnings-per-click for the product on Levanta, if available. Otherwise null."}},"required":["primaryId","ids","title","brandId","brandName","image","category","price","commission","deal","availability","marketplace","access","rating","ratingsTotal","platformEpc"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["products","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/links/status":{"get":{"operationId":"CreatorGetLinksStatusV2","tags":["Links"],"summary":"Get Product Links Status","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","description":"Comma-delimited list of strings representing an array. Example: 1,2,3 equivalent to [1,2,3]"},"required":true,"description":"Comma-delimited list of strings representing an array. Example: 1,2,3 equivalent to [1,2,3]","name":"link_ids","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"marketplace":{"type":"string","enum":["amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"The marketplace the link is associated with"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."}},"required":["id","url","mobileOptimizedUrl","marketplace","active"]}}},"required":["links"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/links":{"post":{"operationId":"CreatorCreateProductLinkV2","tags":["Links"],"summary":"Create Product Link","security":[{"Bearer":[]}],"requestBody":{"description":"The product link to create","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"primary_id":{"type":"string"},"marketplace":{"type":"string","enum":["amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). This union is subject to expand as new marketplaces are added."}},"required":["primary_id","marketplace"]},"subid1":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9-_@./ ]*$","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"subid2":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9-_@./ ]*$","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sharedid":{"type":"string","description":"Will be added to the link parameters as `sharedid`. NOTE: only supported when product.marketplace is shopify.com, otherwise an 422 error will be thrown."}},"required":["product"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["product","storefront"]},"marketplace":{"type":"string","enum":["amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"The marketplace the link is associated with"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"}},"required":["id","type","marketplace","url","mobileOptimizedUrl"]}}}},"400":{"description":"You do not have permission to create a link for this product","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[400]},"message":{"type":"string","enum":["You do not have permission to create a link for this product"]}},"required":["status","message"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"404":{"description":"Product Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Product Not Found"]}},"required":["status","message"]}}}},"415":{"description":"Invalid Content Type: Must be \"application/json\" for post requests","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[415]},"message":{"type":"string","enum":["Invalid Content Type: Must be \"application/json\" for post requests"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/private/find-match":{"post":{"operationId":"CreatorFindMatchV2","tags":["Products"],"summary":"Find a match for a product from any marketplace to Walmart","x-hidden":true,"security":[{"Bearer":[]}],"requestBody":{"description":"The product to find a match for","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}},"required":["title"]},"marketplace":{"type":"string","enum":["walmart.com"],"default":"walmart.com"}},"required":["product"]}}}},"responses":{"200":{"description":"The equivalent product on the target marketplace","content":{"application/json":{"schema":{"type":"object","properties":{"bestMatch":{"type":"object","properties":{"primaryId":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["ASIN","SKU","GTIN","Walmart Item ID","Variant ID"]},"value":{"type":"string"}},"required":["label","value"]}},"title":{"type":"string"},"image":{"type":["string","null"]},"price":{"type":["string","null"]},"marketplace":{"type":"string","enum":["walmart.com"],"default":"walmart.com"},"stockAvailability":{"type":"string"},"trackingUrl":{"type":"string"}},"required":["primaryId","title","image","price","stockAvailability","trackingUrl"]},"otherNearest":{"type":"array","items":{"type":"object","properties":{"primaryId":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["ASIN","SKU","GTIN","Walmart Item ID","Variant ID"]},"value":{"type":"string"}},"required":["label","value"]}},"title":{"type":"string"},"image":{"type":["string","null"]},"price":{"type":["string","null"]},"marketplace":{"type":"string","enum":["walmart.com"],"default":"walmart.com"},"stockAvailability":{"type":"string"},"trackingUrl":{"type":"string"}},"required":["primaryId","title","image","price","stockAvailability","trackingUrl"]}}},"required":["bestMatch","otherNearest"]}}}},"400":{"description":"You do not have permission to find a match for a product","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[400]},"message":{"type":"string","enum":["You do not have permission to find a match for a product"]}},"required":["status","message"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"404":{"description":"No match found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["No match found"]}},"required":["status","message"]}}}},"415":{"description":"Invalid Content Type: Must be \"application/json\" for post requests","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[415]},"message":{"type":"string","enum":["Invalid Content Type: Must be \"application/json\" for post requests"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/brands":{"get":{"operationId":"CreatorListBrandsV2","tags":["Brands"],"summary":"List Brands","description":"List all brands in Levanta's marketplace","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"number","minimum":1,"maximum":100,"default":25,"description":"The maximum number of items to return"},"required":false,"description":"The maximum number of items to return","name":"limit","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"The cursor returned from the last request, if omitted the first page will be returned"},"required":false,"description":"The cursor returned from the last request, if omitted the first page will be returned","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":true,"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added.","name":"marketplace","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"access","in":"query"},{"schema":{"type":"string","description":"Comma-delimited list of UUIDs representing an array"},"required":false,"description":"Comma-delimited list of UUIDs representing an array","name":"brandIds","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"marketplace":{"type":"string","enum":["amazon.com","amazon.com.mx","amazon.co.uk","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl","walmart.com","shopify.com"],"description":"Represents a Levanta marketplace (ex: amazon.co.uk, walmart.com, shopify.com). This union is subject to expand as new marketplaces are added."},"storefronts":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"trackingUrl":{"type":["string","null"],"format":"uri"}},"required":["url","trackingUrl"]}},"bio":{"type":"string"},"image":{"type":"string"},"access":{"type":"boolean"},"commissionLockPeriodDays":{"type":"integer"}},"required":["id","name","marketplace","storefronts","bio","image","access","commissionLockPeriodDays"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["brands","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}}},"webhooks":{}}