{"openapi":"3.1.0","info":{"version":"1.0.0","title":"Levanta Seller 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/seller/api-docs"},"servers":[{"url":"https://app.levanta.io/api/seller/v1"}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{},"parameters":{}},"paths":{"/brands/{brand_id}":{"get":{"summary":"Get Brand by ID","tags":["Brands"],"operationId":"GetBrand","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"brand_id","in":"path"}],"responses":{"200":{"description":"Get a brand","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the brand"},"name":{"type":"string","description":"The name of the brand"},"active":{"type":"boolean","description":"Whether or not the brand is active in Levanta"},"image":{"type":"string"},"bio":{"type":"string"},"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":["id","name","active","image","bio","url","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":"Brand Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Brand 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"]}}}}}}},"/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","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","enum":["true","false"]},"required":false,"name":"active","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":"List brands","content":{"application/json":{"schema":{"type":"object","properties":{"brands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the brand"},"name":{"type":"string","description":"The name of the brand"},"active":{"type":"boolean","description":"Whether or not the brand is active in Levanta"},"image":{"type":"string"},"bio":{"type":"string"},"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":["id","name","active","image","bio","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"]}}}}}}},"/creators/active":{"get":{"operationId":"ListCreators","tags":["Creators"],"summary":"List Creators","description":"List creators that you have an active partnership with. Filter by brand IDs.","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"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creators":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string"},"bio":{"type":"string"},"partneredBrandIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["id","name","email","bio","partneredBrandIds"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["creators","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"]}}}}}}},"/creators/{id}":{"get":{"summary":"Get Creator by ID","tags":["Creators"],"operationId":"GetCreator","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Get a creator","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","description":"Email address. Included if the creator has an active partnership with the seller."},"bio":{"type":"string"},"partneredBrandIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["id","name","bio","partneredBrandIds"]}}}},"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 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[404]},"message":{"type":"string","enum":["Creator 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/reports":{"get":{"operationId":"SellerListCreatorConnectionsReports","tags":["Creator Connections"],"summary":"List Creator Connections Reports","description":"List your creator connection reports. Reports are unique per campaign, creator.creatorConnectionsId, date, and 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"},"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"]},"creator":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"]},"creatorConnectionsId":{"type":"string"},"creatorConnectionsName":{"type":"string","description":"Amazon Creator Connections profile name. This may differ from the Levanta creator team name."}},"required":["id","name","email","creatorConnectionsId","creatorConnectionsName"]}},"required":["asin","date","marketplace","clicks","conversions","commission","sales","campaign","brand","creator"]}},"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":{"get":{"operationId":"SellerListCreatorConnectionsCampaigns","tags":["Creator Connections"],"summary":"List Creator Connections Campaigns","description":"List Your Creator Connections 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","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."},"budget":{"type":"number"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","name","startDate","endDate","status","commissionPercentage","budget","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"]}}}}}}},"/creator-connections/creators":{"get":{"operationId":"SellerListCreatorConnectionsCreators","tags":["Creator Connections"],"summary":"List Creator Connections Creators","description":"List creators that appear in your Creator Connections reports. This includes both claimed (active on Levanta) and unclaimed (not yet on Levanta) creators","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":"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":"creator_ids","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creators":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":["string","null"],"description":"Email address. May be null for unclaimed creators."},"bio":{"type":["string","null"],"description":"Creator bio. May be null for unclaimed creators."},"creatorConnectionsId":{"type":"string"},"creatorConnectionsName":{"type":"string","description":"Amazon Creator Connections profile name. This may differ from the Levanta creator team name."}},"required":["id","name","email","bio","creatorConnectionsId","creatorConnectionsName"]}},"cursor":{"type":["string","null"],"description":"The cursor to use for the next request, if empty there are no more items to return"}},"required":["creators","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/creators/lookup":{"get":{"operationId":"SellerLookupCreatorConnectionsCreatorByCreatorConnectionsIds","tags":["Creator Connections"],"summary":"Lookup Creator Connections Creators by Associates Tags","description":"Look up Creator Connections creators by their Amazon associates tags (e.g. levanta-20). Returns Levanta creator team IDs and metadata for the matched associates tags.","security":[{"Bearer":[]}],"parameters":[{"schema":{"type":"string","description":"Comma-delimited list of strings representing an array. Example: 1,2,3 equivalent to [1,2,3]"},"required":true,"description":"Comma-delimited list of strings representing an array. Example: 1,2,3 equivalent to [1,2,3]","name":"creatorConnectionsIds","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creators":{"type":"array","items":{"type":"object","properties":{"creatorTeamId":{"type":"string","format":"uuid"},"name":{"type":"string"},"creatorConnectionsId":{"type":"string"},"creatorConnectionsName":{"type":"string","description":"Amazon Creator Connections profile name. This may differ from the Levanta creator team name."}},"required":["creatorTeamId","name","creatorConnectionsId","creatorConnectionsName"]}}},"required":["creators"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[401]},"message":{"type":"string","enum":["Unauthorized"]}},"required":["status","message"]}}}},"422":{"description":"Input Validation Failed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","enum":[422]},"message":{"type":"string","enum":["Input Validation Failed"]}},"required":["status","message"]}}}}}}},"/products":{"get":{"operationId":"ListProducts","tags":["Products"],"summary":"List Products","description":"List your products. Filter by brand IDs and ASINs.","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":"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":["true","false"]},"required":false,"name":"active","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"},"pricing":{"type":"object","properties":{"price":{"type":"number"},"currency":{"type":"string","enum":["USD","GBP","CAD","EUR","MXN"]}},"required":["price","currency"]},"commissionPercentage":{"type":"number"},"title":{"type":"string"},"inStock":{"type":"boolean"},"category":{"type":"string"},"brandId":{"type":"string","format":"uuid"},"active":{"type":"boolean","description":"Whether or not the product is active in 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":["asin","pricing","commissionPercentage","title","inStock","category","brandId","active","marketplace"]}},"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 with a date range [start, end].\n                The difference in time between start and end date must be less 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":"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":"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":"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":["standard","cpc","all"],"default":"standard","description":"The type of payout the item is associated with - Standard: commissioning based off of a percentage of sales. Cpc: commissions awarded per click"},"required":false,"description":"The type of payout the item is associated with - Standard: commissioning based off of a percentage of sales. Cpc: commissions awarded per click","name":"payout_model","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":{"id":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date-time","description":"Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ"},"asin":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"cpcCampaignId":{"type":["string","null"],"format":"uuid"},"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"]},"linkId":{"type":"string"},"creatorId":{"type":"string","format":"uuid"},"brandId":{"type":"string","format":"uuid"},"final":{"type":"boolean","description":"When true the numbers in this report will not change"},"sales":{"type":"number"},"commissionAmount":{"type":"number"},"conversions":{"type":"number"},"clicks":{"type":"number"},"detailPageViews":{"type":"number"},"addToCarts":{"type":"number"}},"required":["id","date","asin","cpcCampaignId","marketplace","currency","linkId","creatorId","brandId","final","sales","commissionAmount","conversions","clicks","detailPageViews","addToCarts"]}},"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 Click Reports","description":"List click reports at the date/link granularity with a date range [start, end].\n                The difference in time between start and end date must be less 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":"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":"brand_ids","in":"query"},{"schema":{"type":"string","description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6"},"required":false,"description":"Amazon Standard Identifier (ASIN) for an Amazon product. Example: B09G9FPHY6","name":"asin","in":"query"},{"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":["standard","cpc","all"],"default":"standard","description":"The type of payout the item is associated with - Standard: commissioning based off of a percentage of sales. Cpc: commissions awarded per click"},"required":false,"description":"The type of payout the item is associated with - Standard: commissioning based off of a percentage of sales. Cpc: commissions awarded per click","name":"payout_model","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"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."},"asin":{"type":["string","null"],"description":"The ASIN of the product, if available. If there is no ASIN available, clicks are not attributed to a product, but instead are contributed to a storefront."},"linkId":{"type":"string"},"creatorId":{"type":["string","null"],"format":"uuid"},"brandId":{"type":"string","format":"uuid"},"clicks":{"type":"number"},"final":{"type":"boolean","description":"When true the numbers in this report will not change"},"linkType":{"type":"string","description":"The type of link that the clicks are attributed to."}},"required":["id","date","marketplace","asin","linkId","creatorId","brandId","clicks","final","linkType"]}},"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/brb":{"get":{"operationId":"ListBRBReports","tags":["Reports"],"summary":"List BRB Reports","description":"List brand referral bonus estimates for a given date range [start, end], bucketed by date.\n                The difference in time between start and end date must be less than or equal to 90 days\n                Dates must be specified in ISO format with no offset (UTC), format: \"yyyy-MM-ddTHH:mm:ss.SSSZ\".","security":[{"Bearer":[]}],"parameters":[{"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","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":"Represents an Amazon marketplace."},"required":false,"description":"Represents an Amazon marketplace.","name":"marketplace","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"brand_id","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","minLength":8,"maxLength":8,"description":"Date in the format YYYYMMDD"},"amount":{"type":"number"},"currency":{"type":"string","enum":["AED","AUD","BRL","CAD","EUR","INR","JPY","MXN","SAR","SEK","TRY","GBP","USD"]}},"required":["date","amount","currency"]}}}}},"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":{}}