{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CommitmentSpend":{"properties":{"accruedSpendValue":{"description":"Actual accrual spend amount in commitment currency.","format":"double","type":"number"},"accruedToDateTime":{"description":"Timestamp for accrual spend.","format":"date-time","type":"string"},"commitmentId":{"$ref":"#/components/schemas/CommitmentSpendIdentifier"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"projectedSpendValue":{"description":"Projected spend amount in commitment currency.","format":"double","type":"number"},"spendAtRiskValue":{"description":"Spend at risk amount in commitment currency.","format":"double","type":"number"},"spendDimensionType":{"$ref":"#/components/schemas/SpendDimensionType"}},"required":["accruedToDateTime","commitmentId","currencyCode","spendDimensionType"],"type":"object"},"CommitmentSpendIdentifier":{"properties":{"commitmentId":{"description":"Commitment ID associated with the commitment.","type":"string"},"spendDimension":{"$ref":"#/components/schemas/SpendDimension"}},"required":["commitmentId"],"type":"object"},"CommitmentSpendMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/CommitmentSpendMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"CommitmentSpendMultiStatusSuccess":{"properties":{"commitmentSpend":{"$ref":"#/components/schemas/CommitmentSpend"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["commitmentSpend","index"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"CurrencyCode":{"description":"**CurrencyCode Enum:**\n| CurrencyCode | Description |\n| --- | --- |\n| `AED` | United Arab Emirates Dirham |\n| `AUD` | Australian Dollar |\n| `BRL` | Brazilian Real |\n| `CAD` | Canadian Dollar |\n| `DKK` | Danish Krone |\n| `EUR` | Euro |\n| `GBP` | British Pound Sterling |\n| `INR` | Indian Rupee |\n| `JPY` | Japanese Yen |\n| `MXN` | Mexican Peso |\n| `NOK` | Norwegian Krone |\n| `NZD` | New Zealand Dollar |\n| `SAR` | Saudi Riyal |\n| `SEK` | Swedish Krona |\n| `SGD` | Singapore Dollar |\n| `TRY` | Turkish Lira |\n| `USD` | United States Dollar |","enum":["AED","AUD","BRL","CAD","DKK","EUR","GBP","INR","JPY","MXN","NOK","NZD","SAR","SEK","SGD","TRY","USD"],"type":"string"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n| ErrorCode | Description |\n| --- | --- |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `CONTENT_TOO_LARGE` | The request is too large. Consider splitting it into multiple requests. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |","enum":["BAD_REQUEST","CONTENT_TOO_LARGE","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":999,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"RetrieveCommitmentSpendRequest":{"properties":{"commitmentIds":{"items":{"$ref":"#/components/schemas/CommitmentSpendIdentifier"},"maxItems":1,"minItems":1,"type":"array"}},"required":["commitmentIds"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SpendDimension":{"description":"| SpendDimension | Description |\n| --- | --- |\n| `advertiserAccountId` | Identifier for an advertising account. |\n| `campaignId` | Identifier for campaign entity |\n| `dealId` | Identifier for deal entity |","oneOf":[{"properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"],"title":"advertiserAccountId","type":"object"},{"properties":{"campaignId":{"type":"string"}},"required":["campaignId"],"title":"campaignId","type":"object"},{"properties":{"dealId":{"type":"string"}},"required":["dealId"],"title":"dealId","type":"object"}]},"SpendDimensionType":{"description":"**SpendDimensionType Enum:**\n| SpendDimensionType | Description |\n| --- | --- |\n| `COMMITMENT` | Commitment Level Spend Detail |\n| `ADVERTISER` | Advertiser Level Spend Detail |\n| `CAMPAIGN` | Campaign Level Spend Detail |\n| `DEAL` | Deal Level Spend Detail |","enum":["ADVERTISER","CAMPAIGN","COMMITMENT","DEAL"],"type":"string"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"CommitmentSpends API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/retrieve/commitmentSpends":{"post":{"description":"Retrieve commitment spend\n\n**Requires one of these permissions**:\n[]","operationId":"RetrieveCommitmentSpend","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveCommitmentSpendRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitmentSpendMultiStatusResponse"}}},"description":"RetrieveCommitmentSpend 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["CommitmentSpends"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}