Amazon Web Services, Inc.

AWS Marketplace Agreement Service

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build…

E-commerce#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers and buyers manage their product-related agreements, including listing, searching, creating, and filtering agreements.

Endpoints 25

  • POSTAccept agreement cancellation request/#X-Amz-Target=AWSMPCommerceService_v20200301.AcceptAgreementCancellationRequestAllows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED…
  • POSTAccept agreement payment request/#X-Amz-Target=AWSMPCommerceService_v20200301.AcceptAgreementPaymentRequestAllows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status. Once accepted, the payment request transitions to APPROVED status…
  • POSTAccept agreement request/#X-Amz-Target=AWSMPCommerceService_v20200301.AcceptAgreementRequestAccepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.
  • POSTBatch create billing adjustment request/#X-Amz-Target=AWSMPCommerceService_v20200301.BatchCreateBillingAdjustmentRequestAllows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice…
  • POSTCancel agreement/#X-Amz-Target=AWSMPCommerceService_v20200301.CancelAgreementAllows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation…
  • POSTCancel agreement cancellation request/#X-Amz-Target=AWSMPCommerceService_v20200301.CancelAgreementCancellationRequestAllows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request…
  • POSTCancel agreement payment request/#X-Amz-Target=AWSMPCommerceService_v20200301.CancelAgreementPaymentRequestAllows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status…
  • POSTCreate agreement request/#X-Amz-Target=AWSMPCommerceService_v20200301.CreateAgreementRequestCreates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges,…
  • POSTDescribe agreement/#X-Amz-Target=AWSMPCommerceService_v20200301.DescribeAgreementProvides details about an agreement, such as the proposer, acceptor, start date, and end date.
  • POSTGet agreement cancellation request/#X-Amz-Target=AWSMPCommerceService_v20200301.GetAgreementCancellationRequestRetrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view…
  • POSTGet agreement entitlements/#X-Amz-Target=AWSMPCommerceService_v20200301.GetAgreementEntitlementsObtains details about the entitlements of an agreement.
  • POSTGet agreement payment request/#X-Amz-Target=AWSMPCommerceService_v20200301.GetAgreementPaymentRequestRetrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment…
  • POSTGet agreement terms/#X-Amz-Target=AWSMPCommerceService_v20200301.GetAgreementTermsObtains details about the terms in an agreement that you participated in as proposer or acceptor. The details include: TermType – The type of term, such as…
  • POSTGet billing adjustment request/#X-Amz-Target=AWSMPCommerceService_v20200301.GetBillingAdjustmentRequestRetrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a…
  • POSTList agreement cancellation requests/#X-Amz-Target=AWSMPCommerceService_v20200301.ListAgreementCancellationRequestsLists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find…
  • POSTList agreement charges/#X-Amz-Target=AWSMPCommerceService_v20200301.ListAgreementChargesAllows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of…
  • POSTList agreement invoice line items/#X-Amz-Target=AWSMPCommerceService_v20200301.ListAgreementInvoiceLineItemsAllows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping. Supports invoice-level aggregation…
  • POSTList agreement payment requests/#X-Amz-Target=AWSMPCommerceService_v20200301.ListAgreementPaymentRequestsLists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests…
  • POSTList billing adjustment requests/#X-Amz-Target=AWSMPCommerceService_v20200301.ListBillingAdjustmentRequestsLists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with…
  • POSTReject agreement cancellation request/#X-Amz-Target=AWSMPCommerceService_v20200301.RejectAgreementCancellationRequestAllows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status. Once rejected, the cancellation request transitions to REJECTED…
  • POSTReject agreement payment request/#X-Amz-Target=AWSMPCommerceService_v20200301.RejectAgreementPaymentRequestAllows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status. Once rejected, the payment request transitions to REJECTED status…
  • POSTSearch agreements/#X-Amz-Target=AWSMPCommerceService_v20200301.SearchAgreementsSearches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.
  • POSTSend agreement cancellation request/#X-Amz-Target=AWSMPCommerceService_v20200301.SendAgreementCancellationRequestAllows sellers (proposers) to submit a cancellation request for an active agreement. The cancellation request is created in PENDING_APPROVAL status, at which…
  • POSTSend agreement payment request/#X-Amz-Target=AWSMPCommerceService_v20200301.SendAgreementPaymentRequestAllows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a VariablePaymentTerm…
  • POSTUpdate purchase orders/#X-Amz-Target=AWSMPCommerceService_v20200301.UpdatePurchaseOrdersAllows acceptors to associate purchase orders with agreement charges after an agreement is created.

API details

Base URL
https://agreement-marketplace.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
25 operations on 25 pathsPOST 25
Description format
AWS Smithy model, API version 2020-03-01

How to test the AWS Marketplace Agreement Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Marketplace Agreement Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept agreement cancellation request” (POST /#X-Amz-Target=AWSMPCommerceService_v20200301.AcceptAgreementCancellationRequest), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Marketplace Agreement Service?

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build… It is listed under E-commerce and has 25 endpoints.

Who publishes the AWS Marketplace Agreement Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Marketplace Agreement Service?

Requests go to https://agreement-marketplace.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Marketplace Agreement Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Marketplace Agreement Service have?

25 operations on 25 paths (25 POST).

Is forking the AWS Marketplace Agreement Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.