{"openapi":"3.1.0","info":{"version":"1.0.0","title":"Levanta Creator API","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/v1"}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{},"parameters":{}},"paths":{"/brands":{"get":{"summary":"List Brands","tags":["Brands"],"operationId":"ListBrands","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.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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 to return only brands you have access to"},"required":false,"description":"Whether to return only brands you have access to","name":"access","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brands":{"type":"array","items":{"type":"object","properties":{"brandId":{"type":"string","format":"uuid","description":"The ID of the brand"},"brandName":{"type":"string"},"bio":{"type":"string"},"image":{"type":"string"},"access":{"type":"boolean","description":"Whether or not you have an active partnership with this brand"},"url":{"type":"string"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."}},"required":["brandId","brandName","bio","image","access","url","marketplace"]}},"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"]}}}}}}},"/brands/storefronts":{"get":{"summary":"List Brand Storefronts","description":"List all storefronts for a given brand","tags":["Storefronts"],"operationId":"ListBrandStorefronts","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","format":"uuid","description":"The ID of the brand"},"required":true,"description":"The ID of the brand","name":"brand_id","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"storefronts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the storefront"},"name":{"type":"string"},"levantaProductCount":{"type":"number","description":"The # of products on the page that can earn commissions on Levanta"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."}},"required":["id","name","levantaProductCount","marketplace"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["storefronts","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"]}}}}}}},"/cpc/{campaign_id}":{"get":{"operationId":"GetCpcCampaign","tags":["Cost-Per-Click Campaigns"],"summary":"Get Campaign by ID","description":"Get a Cost-Per-Click campaign by its ID","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The ID of the campaign to get"},"required":true,"description":"The ID of the campaign to get","name":"campaign_id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the campaign"},"startDate":{"type":"string","description":"The start date of the campaign, format: 'YYYY-MM-DD'"},"endDate":{"type":["string","null"],"description":"The end date of the campaign, format: 'YYYY-MM-DD'. If null, the campaign will continue indefinitely (until budget is reached, or canceled)."},"cancellationDate":{"type":["string","null"],"description":"The cancellation date of the campaign, format: 'YYYY-MM-DD'. If null, the campaign has not been canceled."},"product":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"title":{"type":"string"}},"required":["asin","marketplace","title"]},"brandId":{"type":"string","format":"uuid"},"budget":{"type":"object","properties":{"costPerClick":{"type":"number","description":"The amount earned per click, in the currency of the product's marketplace"},"clicks":{"type":"number","description":"The number of clicks attributed to the campaign"},"clicksRemaining":{"type":"number","description":"The number of clicks remaining in the campaign budget"},"reached":{"type":"boolean","description":"Whether or not the campaign budget has been reached"}},"required":["costPerClick","clicks","clicksRemaining","reached"],"description":"Information about the campaign's budget, including the amount of clicks remaining, and whether or not the budget has been reached"},"membership":{"type":["object","null"],"properties":{"earnings":{"type":"object","properties":{"clicks":{"type":"number","description":"The number of clicks you have earned for this campaign"},"amount":{"type":"number","description":"The amount you have earned for this campaign, in the campaign product's currency"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"],"description":"The currency for this campaign"}},"required":["clicks","amount","currency"]},"joinDate":{"type":"string","description":"The date you joined the campaign, format: 'YYYY-MM-DD'"},"removed":{"type":"boolean","description":"Whether or not you have been removed from the campaign"}},"required":["earnings","joinDate","removed"],"description":"Information about your membership in this campaign. If null, you have not joined the campaign"}},"required":["id","startDate","endDate","cancellationDate","product","brandId","budget","membership"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"403":{"description":"You do not have access to CPC APIs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[403]},"message":{"type":"string","enum":["You do not have access to CPC APIs"]}},"required":["status","message"]}}}},"404":{"description":"CPC Campaign Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["CPC Campaign Not Found"]}},"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"]}}}}}}},"/cpc":{"get":{"operationId":"ListCpcCampaigns","tags":["Cost-Per-Click Campaigns"],"summary":"List CPC Campaigns","description":"List all CPC campaigns","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","description":"Comma-delimited list of UUIDs representing an array"},"required":false,"description":"Comma-delimited list of UUIDs representing an array","name":"campaign_ids","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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","all"],"default":"true","description":"Whether to return all campaigns or just campaigns that are currently running,\n                not canceled, have not reached their budget,\n                and that you have not been removed from."},"required":false,"description":"Whether to return all campaigns or just campaigns that are currently running,\n                not canceled, have not reached their budget,\n                and that you have not been removed from.","name":"active","in":"query"},{"schema":{"type":"string","enum":["true","all"],"default":"true","description":"Whether to return all campaigns or just campaigns for brands that you are partnered with"},"required":false,"description":"Whether to return all campaigns or just campaigns for brands that you are partnered with","name":"access","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the campaign"},"startDate":{"type":"string","description":"The start date of the campaign, format: 'YYYY-MM-DD'"},"endDate":{"type":["string","null"],"description":"The end date of the campaign, format: 'YYYY-MM-DD'. If null, the campaign will continue indefinitely (until budget is reached, or canceled)."},"cancellationDate":{"type":["string","null"],"description":"The cancellation date of the campaign, format: 'YYYY-MM-DD'. If null, the campaign has not been canceled."},"product":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"title":{"type":"string"}},"required":["asin","marketplace","title"]},"brandId":{"type":"string","format":"uuid"},"budget":{"type":"object","properties":{"costPerClick":{"type":"number","description":"The amount earned per click, in the currency of the product's marketplace"},"clicks":{"type":"number","description":"The number of clicks attributed to the campaign"},"clicksRemaining":{"type":"number","description":"The number of clicks remaining in the campaign budget"},"reached":{"type":"boolean","description":"Whether or not the campaign budget has been reached"}},"required":["costPerClick","clicks","clicksRemaining","reached"],"description":"Information about the campaign's budget, including the amount of clicks remaining, and whether or not the budget has been reached"},"membership":{"type":["object","null"],"properties":{"earnings":{"type":"object","properties":{"clicks":{"type":"number","description":"The number of clicks you have earned for this campaign"},"amount":{"type":"number","description":"The amount you have earned for this campaign, in the campaign product's currency"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"],"description":"The currency for this campaign"}},"required":["clicks","amount","currency"]},"joinDate":{"type":"string","description":"The date you joined the campaign, format: 'YYYY-MM-DD'"},"removed":{"type":"boolean","description":"Whether or not you have been removed from the campaign"}},"required":["earnings","joinDate","removed"],"description":"Information about your membership in this campaign. If null, you have not joined the campaign"}},"required":["id","startDate","endDate","cancellationDate","product","brandId","budget","membership"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["campaigns","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"403":{"description":"You do not have access to CPC APIs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[403]},"message":{"type":"string","enum":["You do not have access to CPC APIs"]}},"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/cpc":{"get":{"operationId":"ListCpcCampaignReports","tags":["Cost-Per-Click Campaigns"],"summary":"List CPC Reports","description":"List all CPC reports","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":true,"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":true,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"end","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":"campaign_ids","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":"link_ids","in":"query"},{"schema":{"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-_@./ ]"},"required":false,"description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_id","in":"query"},{"schema":{"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-_@./ ]"},"required":false,"description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_sub_id","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]},"commissionEarned":{"type":"number","description":"The commission earned on the report"},"sales":{"type":"number"},"conversions":{"type":"number"},"clicks":{"type":"number","description":"The number of page views for the amazon product's detail page"},"addToCarts":{"type":"number"},"detailPageViews":{"type":"number","description":"The number of page views for the amazon product's detail page"},"directSales":{"type":"number"},"directConversions":{"type":"number"},"directClicks":{"type":"number"},"directAddToCarts":{"type":"number"},"directDetailPageViews":{"type":"number"},"haloSales":{"type":"number"},"haloConversions":{"type":"number"},"haloClicks":{"type":"number"},"haloAddToCarts":{"type":"number"},"haloDetailPageViews":{"type":"number"},"invoice":{"type":"object","properties":{"brandId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","late","paid"],"description":"The status of the invoice."},"year":{"type":"number","exclusiveMinimum":2000,"exclusiveMaximum":3000},"month":{"type":"number","minimum":0,"exclusiveMaximum":13}},"required":["brandId","status","year","month"]},"link":{"type":"object","properties":{"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]},"final":{"type":"boolean","description":"When true the numbers in this report will not change"},"cpcCampaignId":{"type":"string","format":"uuid","description":"The ID of the CPC campaign for the report"},"billableClicks":{"type":"number","description":"The number of clicks that have been attributed to the campaign"}},"required":["asin","date","marketplace","currency","commissionEarned","sales","conversions","clicks","addToCarts","detailPageViews","directSales","directConversions","directClicks","directAddToCarts","directDetailPageViews","haloSales","haloConversions","haloClicks","haloAddToCarts","haloDetailPageViews","invoice","link","final","cpcCampaignId","billableClicks"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["reports","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"403":{"description":"You do not have access to CPC APIs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[403]},"message":{"type":"string","enum":["You do not have access to CPC APIs"]}},"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/cpc":{"get":{"operationId":"ListCpcCampaignLinks","tags":["Cost-Per-Click Campaigns"],"summary":"List CPC Links","description":"List all CPC links","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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":"link_ids","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":"campaign_ids","in":"query"},{"schema":{"type":"string","description":"An array of source IDs to filter by. Source ID: An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"required":false,"description":"An array of source IDs to filter by. Source ID: An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_ids","in":"query"},{"schema":{"type":"string","description":"An array of source sub IDs to filter by. Source Sub ID: An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"required":false,"description":"An array of source sub IDs to filter by. Source Sub ID: An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_sub_ids","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"Whether or not to return active links or inactive links.\n                Links are considered active when created and are only marked as\n                inactive if a partnership between a creator and a brand associated\n                with the link is deleted or the brand associated with the link is\n                deactivated by the seller"},"required":false,"description":"Whether or not to return active links or inactive links.\n                Links are considered active when created and are only marked as\n                inactive if a partnership between a creator and a brand associated\n                with the link is deleted or the brand associated with the link is\n                deactivated by the seller","name":"active","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"},"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"cpcCampaignId":{"type":"string","format":"uuid"}},"required":["id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace","asin","cpcCampaignId"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["links","cursor"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"403":{"description":"You do not have access to CPC APIs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[403]},"message":{"type":"string","enum":["You do not have access to CPC APIs"]}},"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"]}}}}}}},"/cpc/{campaign_id}/join":{"post":{"operationId":"JoinCpcCampaign","tags":["Cost-Per-Click Campaigns"],"summary":"Join CPC Campaign","description":"Join a CPC campaign given its ID","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid","description":"The ID of the campaign to join"},"required":true,"description":"The ID of the campaign to join","name":"campaign_id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Removed from Campaign, Campaign Canceled, or Budget Reached","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[400]},"message":{"type":"string","enum":["Removed from Campaign, Campaign Canceled, or Budget Reached"]}},"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"]}}}},"403":{"description":"You do not have access to CPC APIs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[403]},"message":{"type":"string","enum":["You do not have access to CPC APIs"]}},"required":["status","message"]}}}},"404":{"description":"CPC Campaign Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["CPC Campaign 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"]}}}}}}},"/links/cpc/{campaign_id}":{"post":{"operationId":"CreateCpcCampaignLink","tags":["Cost-Per-Click Campaigns"],"summary":"Create CPC Link","description":"Create a link for a CPC campaign","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"campaign_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"source_id":{"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-_@./ ]"},"source_sub_id":{"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-_@./ ]"},"source_name":{"type":"string","maxLength":250,"default":"","description":"Display name for the source within Levanta"},"auto_join":{"type":"string","enum":["true","false"],"default":"true","description":"Whether or not to join the campaign if not yet joined"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"},"cpcCampaignId":{"type":"string","format":"uuid","description":"The ID of the CPC campaign for the link"}},"required":["asin","id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace","cpcCampaignId"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"403":{"description":"You do not have access to CPC APIs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[403]},"message":{"type":"string","enum":["You do not have access to CPC APIs"]}},"required":["status","message"]}}}},"404":{"description":"CPC Campaign or Link Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["CPC Campaign or Link 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"]}}}}}}},"/creator-connections/reports":{"get":{"operationId":"CreatorListCreatorConnectionsReports","tags":["Creator Connections"],"summary":"List Creator Connections Reports","description":"List your creator connection reports. Reports are unique per campaign per date per asin.","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":true,"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":true,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"end","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":"brand_ids","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":"campaign_ids","in":"query"},{"schema":{"type":"string","description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]"},"required":false,"description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]","name":"asins","in":"query"},{"schema":{"type":"string","enum":["amazon.com"],"default":"amazon.com"},"required":false,"name":"marketplace","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string"},"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"marketplace":{"type":"string","enum":["amazon.com"],"description":"Amazon US marketplace."},"clicks":{"type":"number"},"conversions":{"type":"number"},"commission":{"type":"number","description":"Commission earned in creator connections. IMPORTANT: this commission is not paid out through Levanta"},"sales":{"type":"number"},"storeId":{"type":"string"},"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]}},"required":["asin","date","marketplace","clicks","conversions","commission","sales","storeId","campaign","brand"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["reports","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"]}}}}}}},"/creator-connections/campaigns/{campaign_id}/products":{"get":{"tags":["Creator Connections"],"summary":"List Products for a Creator Connections Campaign","description":"List Products, Links, and Loyalty Programs for a creator connections campaign","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"campaign_id","in":"path"},{"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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"},"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"Campaign name as listed in Creator Connections"},"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"},"status":{"type":"string","description":"Status as listed in Creator Connections. Common values are DELIVERING, OUT_OF_BUDGET, ENDED"},"commissionPercentage":{"type":"number","description":"Commission rate for the campaign. Values range from 0 to 1."},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","name","startDate","endDate","status","commissionPercentage","brand"]},"products":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com"],"description":"Amazon US marketplace."},"title":{"type":"string"},"pricing":{"type":"object","properties":{"price":{"type":"number"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["price","currency"]},"inStock":{"type":"boolean"},"image":{"type":"string"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"storeId":{"type":"string"}},"required":["url","storeId"]}},"activeLoyaltyProgram":{"type":["object","null"],"properties":{"program":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"membershipActiveThrough":{"type":["string","null"],"description":"The date your membership for the loyalty program is active until.\n                     Will equal endMonth if the program has not been cancelled and you have not been removed.\n                     If null, the program doesn't have a set end date and your membership is active indefinitely.\n                     Format: yyyy-MM\n                    "},"startMonth":{"type":"string","description":"The program is active from the start of this month. Format: yyyy-MM"},"endMonth":{"type":["string","null"],"description":"The program is active until the end of this month. Format: yyyy-MM.\n                     If null the program is active indefinitely"},"target":{"type":"object","properties":{"sales":{"type":"number","description":"The sales target for the loyalty program. For every sales target reached you will earn bonus amount.\n                        This is cyclical so if sales is $50 and bonus is $10 if you drive $120 you will earn $20 in bonus.\n                        "},"bonus":{"type":"number","description":"The bonus amount to be awarded for every sales target reached."}},"required":["sales","bonus"]},"accrued":{"type":"object","properties":{"sales":{"type":"number","description":"The total sales that count for this loyalty program"},"bonus":{"type":"number","description":"The total bonus you have accrued for this loyalty program"}},"required":["sales","bonus"]},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["id","name","brand","membershipActiveThrough","startMonth","endMonth","target","accrued","currency"]},"productSalesForProgram":{"type":"number","description":"The sales that the product has earned for the active loyalty program"}},"required":["program","productSalesForProgram"],"description":"The loyalty program that is currently active in Levanta and\n                         currently applies to this product. Null if no such program exists"}},"required":["asin","marketplace","title","pricing","inStock","image","links","activeLoyaltyProgram"]}}},"required":["cursor","campaign","products"]}}}},"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"]}}}}}}},"/creator-connections/campaigns/{campaign_id}/loyalty-programs":{"get":{"tags":["Creator Connections"],"summary":"List Loyalty Programs for a Creator Connections Campaign","description":"List Loyalty Programs for a Creator Connections Campaign.\n     Lists any loyalty program that was active for the campaign at some point","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"campaign_id","in":"path"},{"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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"Campaign name as listed in Creator Connections"},"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"},"status":{"type":"string","description":"Status as listed in Creator Connections. Common values are DELIVERING, OUT_OF_BUDGET, ENDED"},"commissionPercentage":{"type":"number","description":"Commission rate for the campaign. Values range from 0 to 1."},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","name","startDate","endDate","status","commissionPercentage","brand"]},"programs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"membershipActiveThrough":{"type":["string","null"],"description":"The date your membership for the loyalty program is active until.\n                     Will equal endMonth if the program has not been cancelled and you have not been removed.\n                     If null, the program doesn't have a set end date and your membership is active indefinitely.\n                     Format: yyyy-MM\n                    "},"startMonth":{"type":"string","description":"The program is active from the start of this month. Format: yyyy-MM"},"endMonth":{"type":["string","null"],"description":"The program is active until the end of this month. Format: yyyy-MM.\n                     If null the program is active indefinitely"},"target":{"type":"object","properties":{"sales":{"type":"number","description":"The sales target for the loyalty program. For every sales target reached you will earn bonus amount.\n                        This is cyclical so if sales is $50 and bonus is $10 if you drive $120 you will earn $20 in bonus.\n                        "},"bonus":{"type":"number","description":"The bonus amount to be awarded for every sales target reached."}},"required":["sales","bonus"]},"accrued":{"type":"object","properties":{"sales":{"type":"number","description":"The total sales that count for this loyalty program"},"bonus":{"type":"number","description":"The total bonus you have accrued for this loyalty program"}},"required":["sales","bonus"]},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["id","name","brand","membershipActiveThrough","startMonth","endMonth","target","accrued","currency"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["campaign","programs","cursor"]}}}},"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":"Creator Connections Campaign Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Creator Connections Campaign Not Found"]}},"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"]}}}}}}},"/creator-connections/campaigns":{"get":{"operationId":"CreatorListCreatorConnectionsCampaigns","tags":["Creator Connections"],"summary":"List Creator Connections Campaigns","description":"List your creator connections campaigns that you are a member of.","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","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","enum":["amazon.com"],"default":"amazon.com"},"required":false,"name":"marketplace","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":"brand_ids","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"Campaign name as listed in Creator Connections"},"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"},"status":{"type":"string","description":"Status as listed in Creator Connections. Common values are DELIVERING, OUT_OF_BUDGET, ENDED"},"commissionPercentage":{"type":"number","description":"Commission rate for the campaign. Values range from 0 to 1."},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","name","startDate","endDate","status","commissionPercentage","brand"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["campaigns","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":"ListDeals","tags":["Deals"],"summary":"List Deals","security":[{"Bearer":[]}],"parameters":[{"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"},{"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":"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":"before","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":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]"},"required":false,"description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]","name":"asins","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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"}],"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"]},"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"title":{"type":"string","description":"The amazon title 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"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]},"fullPrice":{"type":"number"},"discountPrice":{"type":"number"},"discountPercentage":{"type":"number"},"verified":{"type":"boolean"},"promoCode":{"type":["string","null"]},"brand":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"required":["type","asin","marketplace","title","startDate","endDate","currency","fullPrice","discountPrice","discountPercentage","verified","promoCode","brand"]}},"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"]}}}}}}},"/invoices/items":{"get":{"operationId":"ListInvoiceItems","tags":["Invoices"],"summary":"List Invoice Items","description":"Get a list of invoice items for a given month and year","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","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":["number","null"],"minimum":0,"maximum":11},"required":false,"name":"month","in":"query"},{"schema":{"type":"number","minimum":2023,"maximum":2030},"required":true,"name":"year","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"month":{"type":"number"},"year":{"type":"number"},"sales":{"type":"number"},"commission":{"type":"number"},"cpcCommission":{"type":"number"},"status":{"type":"string","enum":["pending","late","paid"],"description":"The status of the invoice."},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]},"marketplace":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."}},"required":["brand","month","year","sales","commission","cpcCommission","status","currency"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["items","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":{"get":{"operationId":"ListProductLinks","tags":["Links"],"summary":"List Product Links","description":"List all product links. Filter by asins, links, and sources.","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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":"link_ids","in":"query"},{"schema":{"type":"string","description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]"},"required":false,"description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]","name":"asins","in":"query"},{"schema":{"type":"string","description":"An array of source IDs to filter by. Source ID: An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"required":false,"description":"An array of source IDs to filter by. Source ID: An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_ids","in":"query"},{"schema":{"type":"string","description":"An array of source sub IDs to filter by. Source Sub ID: An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"required":false,"description":"An array of source sub IDs to filter by. Source Sub ID: An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_sub_ids","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"Whether or not to return active links or inactive links.\n                Links are considered active when created and are only marked as\n                inactive if a partnership between a creator and a brand associated\n                with the link is deleted or the brand associated with the link is\n                deactivated by the seller"},"required":false,"description":"Whether or not to return active links or inactive links.\n                Links are considered active when created and are only marked as\n                inactive if a partnership between a creator and a brand associated\n                with the link is deleted or the brand associated with the link is\n                deactivated by the seller","name":"active","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["asin","id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["links","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"]}}}}}},"post":{"operationId":"CreateProductLink","tags":["Links"],"summary":"Create Product Link","description":"Create a product link or retrieve an existing one via a unique asin/country/source_id combination. If source_id is not provided the value \"default\" will be used. If country is not provided the value \"US\" will be used.","security":[{"Bearer":[]}],"requestBody":{"description":"The product link to create","content":{"application/json":{"schema":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"The marketplace the product is associated with"},"source_id":{"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-_@./ ]"},"source_sub_id":{"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-_@./ ]"},"source_name":{"type":"string","maxLength":250,"default":"","description":"Display name for the source within Levanta"}},"required":["asin"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["asin","id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]}}}},"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"]}}}}}}},"/links/storefronts":{"get":{"operationId":"ListStorefrontLinks","tags":["Links"],"summary":"List Storefront Links","description":"List all storefront links. Filter by brand_ids, link_ids, source_ids, source_sub_ids, and storefront_ids","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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":"storefront_ids","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":"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":"link_ids","in":"query"},{"schema":{"type":"string","description":"An array of source IDs to filter by. Source ID: An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"required":false,"description":"An array of source IDs to filter by. Source ID: An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_ids","in":"query"},{"schema":{"type":"string","description":"An array of source sub IDs to filter by. Source Sub ID: An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"required":false,"description":"An array of source sub IDs to filter by. Source Sub ID: An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_sub_ids","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"Whether or not to return active links or inactive links.\n                Links are considered active when created and are only marked as\n                inactive if a partnership between a creator and a brand associated\n                with the link is deleted or the brand associated with the link is\n                deactivated by the seller"},"required":false,"description":"Whether or not to return active links or inactive links.\n                Links are considered active when created and are only marked as\n                inactive if a partnership between a creator and a brand associated\n                with the link is deleted or the brand associated with the link is\n                deactivated by the seller","name":"active","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"storefrontName":{"type":"string"},"storefrontId":{"type":"string"},"brandId":{"type":"string","format":"uuid"},"levantaProductCount":{"type":"number"},"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["storefrontName","storefrontId","brandId","levantaProductCount","id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["links","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"]}}}}}},"post":{"operationId":"CreateDefaultStorefrontLink","tags":["Links"],"summary":"Create Default Storefront Link","description":"Create a link for the default storefront of a brand","security":[{"Bearer":[]}],"requestBody":{"description":"The storefront link to create","content":{"application/json":{"schema":{"type":"object","properties":{"brand_id":{"type":"string","format":"uuid"},"source_id":{"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-_@./ ]"},"source_sub_id":{"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-_@./ ]"},"source_name":{"type":"string","maxLength":250,"default":"","description":"Display name for the source within Levanta"}},"required":["brand_id"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"},"levantaProductCount":{"type":"number"}},"required":["id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace","levantaProductCount"]}}}},"400":{"description":"You do not have permission to create a default storefront link for this brand","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[400]},"message":{"type":"string","enum":["You do not have permission to create a default storefront link for this brand"]}},"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":"Default Storefront for Brand or Link Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Default Storefront for Brand or Link 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"]}}}}}}},"/links/{link_id}":{"get":{"operationId":"GetProductLink","tags":["Links"],"summary":"Get Product Link by ID","description":"Get a product link by its ID","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","maxLength":250},"required":true,"name":"link_id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"asin":{"type":["string","null"],"description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["asin","id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]}}}},"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":"Link Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Link Not Found"]}},"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/storefronts/{storefront_id}":{"post":{"operationId":"CreateStorefrontLinkById","tags":["Links"],"summary":"Create Storefront Link by ID","description":"Get a storefront link by its ID","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"storefront_id","in":"path"}],"requestBody":{"description":"The storefront link to create","content":{"application/json":{"schema":{"type":"object","properties":{"source_id":{"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-_@./ ]"},"source_sub_id":{"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-_@./ ]"},"source_name":{"type":"string","maxLength":250,"default":"","description":"Display name for the source within Levanta"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"},"levantaProductCount":{"type":"number"}},"required":["id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace","levantaProductCount"]}}}},"400":{"description":"You do not have permission to create a storefront link for this brand","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[400]},"message":{"type":"string","enum":["You do not have permission to create a storefront link for this brand"]}},"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":"Storefront or Link Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Storefront or Link 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"]}}}}}}},"/loyalty-programs":{"get":{"operationId":"ListLoyaltyPrograms","tags":["Loyalty Programs"],"summary":"List Loyalty Programs","description":"List loyalty programs","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":["active","ended","all"],"default":"active"},"required":false,"name":"status","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":"brand_ids","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":"program_ids","in":"query"},{"schema":{"type":"string","enum":["amazon.com"],"default":"amazon.com"},"required":false,"name":"marketplace","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"programs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"membershipActiveThrough":{"type":["string","null"],"description":"The date your membership for the loyalty program is active until.\n                     Will equal endMonth if the program has not been cancelled and you have not been removed.\n                     If null, the program doesn't have a set end date and your membership is active indefinitely.\n                     Format: yyyy-MM\n                    "},"startMonth":{"type":"string","description":"The program is active from the start of this month. Format: yyyy-MM"},"endMonth":{"type":["string","null"],"description":"The program is active until the end of this month. Format: yyyy-MM.\n                     If null the program is active indefinitely"},"target":{"type":"object","properties":{"sales":{"type":"number","description":"The sales target for the loyalty program. For every sales target reached you will earn bonus amount.\n                        This is cyclical so if sales is $50 and bonus is $10 if you drive $120 you will earn $20 in bonus.\n                        "},"bonus":{"type":"number","description":"The bonus amount to be awarded for every sales target reached."}},"required":["sales","bonus"]},"accrued":{"type":"object","properties":{"sales":{"type":"number","description":"The total sales that count for this loyalty program"},"bonus":{"type":"number","description":"The total bonus you have accrued for this loyalty program"}},"required":["sales","bonus"]},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["id","name","brand","membershipActiveThrough","startMonth","endMonth","target","accrued","currency"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["programs","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"]}}}}}}},"/loyalty-programs/{program_id}/products":{"get":{"operationId":"ListProductsForLoyaltyProgram","tags":["Loyalty Programs"],"summary":"List Products for Loyalty Program","description":"List products for a loyalty program","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"program_id","in":"path"},{"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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"program":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"membershipActiveThrough":{"type":["string","null"],"description":"The date your membership for the loyalty program is active until.\n                     Will equal endMonth if the program has not been cancelled and you have not been removed.\n                     If null, the program doesn't have a set end date and your membership is active indefinitely.\n                     Format: yyyy-MM\n                    "},"startMonth":{"type":"string","description":"The program is active from the start of this month. Format: yyyy-MM"},"endMonth":{"type":["string","null"],"description":"The program is active until the end of this month. Format: yyyy-MM.\n                     If null the program is active indefinitely"},"target":{"type":"object","properties":{"sales":{"type":"number","description":"The sales target for the loyalty program. For every sales target reached you will earn bonus amount.\n                        This is cyclical so if sales is $50 and bonus is $10 if you drive $120 you will earn $20 in bonus.\n                        "},"bonus":{"type":"number","description":"The bonus amount to be awarded for every sales target reached."}},"required":["sales","bonus"]},"accrued":{"type":"object","properties":{"sales":{"type":"number","description":"The total sales that count for this loyalty program"},"bonus":{"type":"number","description":"The total bonus you have accrued for this loyalty program"}},"required":["sales","bonus"]},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["id","name","brand","membershipActiveThrough","startMonth","endMonth","target","accrued","currency"]},"products":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"title":{"type":"string"},"image":{"type":"string"},"inStock":{"type":"boolean"},"pricing":{"type":"object","properties":{"price":{"type":"number"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["price","currency"]},"salesForProgram":{"type":"number"}},"required":["asin","marketplace","title","image","inStock","pricing","salesForProgram"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["program","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"]}}}},"404":{"description":"Loyalty Program Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Loyalty Program Not Found"]}},"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/{asin}":{"get":{"operationId":"GetProductByAsin","tags":["Products"],"summary":"Get Product by ASIN","description":"Get a product in amazon.com by asin","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"required":true,"description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6","name":"asin","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"pricing":{"type":"object","properties":{"price":{"type":"number"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["price","currency"]},"commission":{"type":"number"},"title":{"type":"string","description":"The amazon title of the product"},"inStock":{"type":"boolean"},"category":{"type":"string"},"brandId":{"type":"string","format":"uuid","description":"The ID of the brand the product is associated with"},"access":{"type":"boolean","description":"true when you have an active partnership with the brand the product is associated with"},"image":{"type":"string"},"rating":{"type":["string","null"],"description":"Current rating of the product"},"ratingsTotal":{"type":["number","null"],"description":"Total number of ratings for this product"},"platformEpc":{"type":["number","null"],"description":"Earnings-per-click for the product on Levanta, if available. Otherwise null."},"parentAsin":{"type":["string","null"]},"variations":{"type":"array","items":{"type":"string"}}},"required":["asin","marketplace","pricing","commission","title","inStock","category","brandId","access","image","rating","ratingsTotal","platformEpc","parentAsin","variations"]}}}},"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"]}}}},"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/{marketplace}/{asin}":{"get":{"operationId":"GetProductByAsinMarketplaceDomain","tags":["Products"],"summary":"Get Product by Marketplace/ASIN","description":"Get a product by its unique marketplace/asin pair","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"required":true,"description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6","name":"asin","in":"path"},{"schema":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"]},"required":true,"name":"marketplace","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"pricing":{"type":"object","properties":{"price":{"type":"number"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["price","currency"]},"commission":{"type":"number"},"title":{"type":"string","description":"The amazon title of the product"},"inStock":{"type":"boolean"},"category":{"type":"string"},"brandId":{"type":"string","format":"uuid","description":"The ID of the brand the product is associated with"},"access":{"type":"boolean","description":"true when you have an active partnership with the brand the product is associated with"},"image":{"type":"string"},"rating":{"type":["string","null"],"description":"Current rating of the product"},"ratingsTotal":{"type":["number","null"],"description":"Total number of ratings for this product"},"platformEpc":{"type":["number","null"],"description":"Earnings-per-click for the product on Levanta, if available. Otherwise null."},"parentAsin":{"type":["string","null"]},"variations":{"type":"array","items":{"type":"string"}}},"required":["asin","marketplace","pricing","commission","title","inStock","category","brandId","access","image","rating","ratingsTotal","platformEpc","parentAsin","variations"]}}}},"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"]}}}},"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":"ListProducts","tags":["Products"],"summary":"List Products","description":"List active products in Levanta's product catalog. Sort products by title, commission, or price.\n                Filter products by asin, brand, access, and in stock status. Access represents whether or not a creator has an active partnership\n                with the brand that the product belongs to.","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]"},"required":false,"description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]","name":"asins","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","enum":["true","false"]},"required":false,"name":"in_stock","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","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"pricing":{"type":"object","properties":{"price":{"type":"number"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["price","currency"]},"commission":{"type":"number"},"title":{"type":"string","description":"The amazon title of the product"},"inStock":{"type":"boolean"},"category":{"type":"string"},"brandId":{"type":"string","format":"uuid","description":"The ID of the brand the product is associated with"},"access":{"type":"boolean","description":"true when you have an active partnership with the brand the product is associated with"},"image":{"type":"string"},"rating":{"type":["string","null"],"description":"Current rating of the product"},"ratingsTotal":{"type":["number","null"],"description":"Total number of ratings for this product"},"platformEpc":{"type":["number","null"],"description":"Earnings-per-click for the product on Levanta, if available. Otherwise null."}},"required":["asin","marketplace","pricing","commission","title","inStock","category","brandId","access","image","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"]}}}}}}},"/reports":{"get":{"operationId":"ListReports","tags":["Reports"],"summary":"List Reports","description":"List per-product reports at the product/date/link granularity within a date range [start, end].\n    Filter by asins, links, or source. The difference in time between the start date and end date can be no longer than 1 year.\n    Dates must be specified in ISO format with no offset (UTC), format: \"yyyy-MM-ddTHH:mm:ss.SSSZ\".","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":true,"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":true,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"end","in":"query"},{"schema":{"type":"string","description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]"},"required":false,"description":"Comma-delimited list of ASINs representing an array. Example: B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]","name":"asins","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":"link_ids","in":"query"},{"schema":{"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-_@./ ]"},"required":false,"description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_id","in":"query"},{"schema":{"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-_@./ ]"},"required":false,"description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_sub_id","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]},"commissionEarned":{"type":"number","description":"The commission earned on the report"},"sales":{"type":"number"},"conversions":{"type":"number"},"clicks":{"type":"number","description":"The number of page views for the amazon product's detail page"},"addToCarts":{"type":"number"},"detailPageViews":{"type":"number","description":"The number of page views for the amazon product's detail page"},"directSales":{"type":"number"},"directConversions":{"type":"number"},"directClicks":{"type":"number"},"directAddToCarts":{"type":"number"},"directDetailPageViews":{"type":"number"},"haloSales":{"type":"number"},"haloConversions":{"type":"number"},"haloClicks":{"type":"number"},"haloAddToCarts":{"type":"number"},"haloDetailPageViews":{"type":"number"},"invoice":{"type":"object","properties":{"brandId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","late","paid"],"description":"The status of the invoice."},"year":{"type":"number","exclusiveMinimum":2000,"exclusiveMaximum":3000},"month":{"type":"number","minimum":0,"exclusiveMaximum":13}},"required":["brandId","status","year","month"]},"link":{"type":"object","properties":{"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]},"final":{"type":"boolean","description":"When true the numbers in this report will not change"}},"required":["asin","date","marketplace","currency","commissionEarned","sales","conversions","clicks","addToCarts","detailPageViews","directSales","directConversions","directClicks","directAddToCarts","directDetailPageViews","haloSales","haloConversions","haloClicks","haloAddToCarts","haloDetailPageViews","invoice","link","final"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["reports","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/clicks":{"get":{"operationId":"ListClickReports","tags":["Reports"],"summary":"List Clicks","description":"Get click reports at the date/link granularity within a date range [start, end]. Filter by link or source.\n    The difference in time between the start date and end date can be no longer than 1 year. Dates must be specified in ISO format\n    with no offset (UTC), format: \"yyyy-MM-ddTHH:mm:ss.SSSZ\".","security":[{"Bearer":[]}],"parameters":[{"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"},{"schema":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"required":true,"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":true,"description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ","name":"end","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":"link_ids","in":"query"},{"schema":{"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-_@./ ]"},"required":false,"description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_id","in":"query"},{"schema":{"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-_@./ ]"},"required":false,"description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]","name":"source_sub_id","in":"query"},{"schema":{"type":"string","enum":["all","amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"default":"amazon.com","description":"Represents an Amazon marketplace. If \"all\" is specified then the scope is all marketplaces. This union is subject to expand as new marketplaces are added."},"required":false,"description":"Represents an Amazon marketplace. 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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reports":{"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"},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"Represents an Amazon marketplace. This union is subject to expand as new marketplaces are added."},"clicks":{"type":"number"},"link":{"type":"object","properties":{"id":{"type":"string"},"sourceId":{"type":"string","description":"An ID that identifies where the created link will be used. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceSubId":{"type":"string","description":"An ID to further identify the link underneath the source_id namespace. Allowed characters: [a-zA-Z0-9-_@./ ]"},"sourceName":{"type":"string","description":"Display name for the source within Levanta"},"url":{"type":"string"},"mobileOptimizedUrl":{"type":"string"},"active":{"type":"boolean","description":"Whether or not the link is active. Inactive links do not earn commissions."},"type":{"type":"string","enum":["product","storefront"],"description":"The type of the link. Product links are for amazon asin pages. Storefront links are for amazon storefront pages."},"marketplace":{"type":"string","enum":["amazon.com","amazon.co.uk","amazon.com.mx","amazon.ca","amazon.de","amazon.es","amazon.fr","amazon.it","amazon.nl"],"description":"The marketplace the link is associated with"}},"required":["id","sourceId","sourceSubId","sourceName","url","mobileOptimizedUrl","active","type","marketplace"]},"final":{"type":"boolean","description":"When true the numbers in this report will not change"}},"required":["date","marketplace","clicks","link","final"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["reports","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":{}}