Proposal

Search proposals

get

Search proposals

Query parameters

NamestringOptional

Proposal name

EmailstringOptional

The bill to or sell to email

UpdatedAfterstringOptional

The UTC date and time in ISO 8601 format

UpdatedBeforestringOptional

The UTC date and time in ISO 8601 format

UpdatedBystring[]Optional

The unique external system user identifier

CreatedBystring[]Optional

The unique external system user identifier

SourcestringOptional

The source from where the proposal was created

CreatedAfterstringOptional

The UTC date and time in ISO 8601 format

CreatedBeforestringOptional

The UTC date and time in ISO 8601 format

LockedbooleanOptional

Retrieve proposals that are locked or not

Pageinteger · min: 1 · max: 9999Required

The page at which the proposals should be returned

Default: 1

Limitinteger · min: 1 · max: 100Required

The maximum number of proposals to return

Default: 10

LinkIdstringOptional

The link id for any status

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

pageintegerRequired

The incoming page value

Example: 0

limitintegerRequired

The incoming limit value

Example: 10

proposalsCountintegerRequired

The total number of proposal matching the criterias

Example: 1

pagesCountintegerRequired

The total number of pages for proposal matching the criterias

Example: 1

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/proposals/

HTTPcURLJavaScriptPython

GET /rest/6.0/proposals/?Page=1&Limit=10 HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "Proposals": [
    {
      "ProposalId": "2c0a8b3a-54fe-4ff9-ac19-a48e49d90298",
      "Name": "testName",
      "SentBy": {
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "Email": "[email protected]"
      },
      "ExpirationDate": "2022-05-20T17:21:42+00:00",
      "Version": 3,
      "CreatedDate": "2020-06-26T11:35:04+00:00",
      "UpdatedDate": "2020-06-26T11:35:13+00:00",
      "CreatedBy": "[email protected]",
      "UpdatedBy": "",
      "Locked": false,
      "Source": "MERCHANT_API",
      "Type": "acquisition",
      "Status": "accepted",
      "StatusComment": "",
      "Content": {
        "Language": "ro",
        "Currency": "ron",
        "LineItems": [
          {
            "ProductName": "Antivirus",
            "ProductCode": "FP10",
            "Quantity": 2,
            "Price": 54,
            "DiscountedPrice": 50.6,
            "PriceType": "gross",
            "PriceOptions": [],
            "AdditionalFields": [],
            "ImmediateAction": "now",
            "ContractPeriod": 0,
            "NextContractRenewalPeriod": 0,
            "ProrationDate": "2020-01-04T12:32:22Z",
            "MerchantDealAutoRenewal": false,
            "ClientDealAutoRenewal": false
          }
        ],
        "AdditionalFields": []
      },
      "BillTo": {
        "Company": "Randcomp",
        "Phone": "12172196850",
        "Email": "[email protected]",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius"
      },
      "SellTo": {
        "Company": "Randcomp",
        "VatCode": "85421564",
        "Phone": "12172196850",
        "Email": "[email protected]",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "TaxExemptionId": ""
      },
      "Tac": {
        "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com...",
        "AcceptedDate": "2020-06-26T11:35:13+00:00"
      },
      "Links": [
        {
          "LinkId": "d6311c81-8f1a-4381-8d9d-fd6f12e3c0b7",
          "Url": "https://proposal.2checkout.com/merchant-code/test/link-id/d6311c81-8f1a-4381-8d9d-fd6f12e3c0b7",
          "Status": "sent"
        },
        {
          "LinkId": "971be349-31f6-4177-ad7f-c78e61ec7702",
          "Url": "https://proposal.2checkout.com/merchant-code/test/link-id/971be349-31f6-4177-ad7f-c78e61ec7702",
          "Status": "accepted"
        }
      ]
    },
    {
      "ProposalId": "4b66ca42-5944-45df-8ec6-b1ca9228df0e",
      "Name": "Renewal of antivirus",
      "Version": 1,
      "CreatedDate": "2020-06-26T11:28:04+00:00",
      "UpdatedDate": "2020-06-26T11:28:04+00:00",
      "CreatedBy": "[email protected]",
      "Locked": false,
      "Source": "salesforce_cpq",
      "Type": "acquisition",
      "Status": "opened",
      "Content": {
        "Language": "ro",
        "Currency": "ron",
        "Terms": 1,
        "LineItems": [
          {
            "ProductName": "Antivirus",
            "ProductCode": "FP10",
            "Quantity": 2,
            "Price": 54.2,
            "DiscountedPrice": 50,
            "PriceType": "gross",
            "PriceOptions": [],
            "AdditionalFields": [],
            "ImmediateAction": "now",
            "ContractPeriod": 0,
            "NextContractRenewalPeriod": 0,
            "ProrationDate": "2020-01-04T12:32:22Z",
            "MerchantDealAutoRenewal": false,
            "ClientDealAutoRenewal": false
          }
        ],
        "AdditionalFields": []
      },
      "BillTo": {
        "Company": "Randcomp",
        "Phone": "12172196850",
        "Email": "[email protected]",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "John",
        "LastName": "Doe"
      },
      "SellTo": {
        "Company": "Randcomp",
        "VatCode": "85421564",
        "Phone": "12172196850",
        "Email": "[email protected]",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "John",
        "LastName": "Doe",
        "TaxExemptionId": ""
      },
      "Tac": {
        "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
      },
      "Links": []
    },
    {
      "ProposalId": "5eec0d50-4a86-423e-b793-0fba49737a0e",
      "Name": "testName",
      "SentBy": {
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "Email": "[email protected]"
      },
      "ExpirationDate": "2022-05-20T17:21:42+00:00",
      "Version": 2,
      "CreatedDate": "2020-06-26T11:28:28+00:00",
      "UpdatedDate": "2020-06-26T11:32:36+00:00",
      "CreatedBy": "[email protected]",
      "UpdatedBy": "Jonathan2",
      "Locked": false,
      "Source": "MERCHANT_API",
      "Type": "acquisition",
      "Status": "sent",
      "StatusComment": "",
      "Content": {
        "Language": "ro",
        "Currency": "ron",
        "LineItems": [
          {
            "ProductName": "Antivirus",
            "ProductCode": "FP10",
            "Quantity": 2,
            "Price": 54,
            "DiscountedPrice": 50.6,
            "PriceType": "gross",
            "PriceOptions": [],
            "AdditionalFields": [],
            "ImmediateAction": "now",
            "ContractPeriod": 0,
            "NextContractRenewalPeriod": 0,
            "MerchantDealAutoRenewal": false,
            "ClientDealAutoRenewal": false
          }
        ],
        "AdditionalFields": []
      },
      "BillTo": {
        "Company": "Randcomp",
        "Phone": "12172196850",
        "Email": "[email protected]",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius"
      },
      "SellTo": {
        "Company": "Randcomp",
        "VatCode": "85421564",
        "Phone": "12172196850",
        "Email": "[email protected]",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "TaxExemptionId": ""
      },
      "Tac": {
        "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
      },
      "Links": [
        {
          "LinkId": "b0dfea4c-ff0f-4a35-be9e-36eed4142218",
          "Url": "https://proposal.2checkout.com/merchant-code/test/link-id/b0dfea4c-ff0f-4a35-be9e-36eed4142218",
          "Status": "sent"
        }
      ]
    }
  ],
  "Page": 1,
  "Limit": 100,
  "ProposalsCount": 3,
  "PagesCount": 1
}

Create proposal

post

Create proposal

Header parameters

Acceptstring · enumRequiredExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

Proposal create request

NamestringOptional

The name of the proposal

Example: Renewal of antivirus

UserIdstringOptional

The unique external system user identifier

Example: [email protected]

Typestring · enumRequired

The type of the proposal

Default: acquisitionExample: acquisitionPossible values:

SourcestringRequired

The source from where the proposal was created

Example: SALESFORCE_CPQ

Scopestring · enum · nullableOptional

Amendment scope, send only for amendments. Use null to reset on update.

Default: nullExample: autorenewalPossible values:

Responses

201

OK

application/json

400

Bad Request

application/json

post

/proposals/

HTTPcURLJavaScriptPython

POST /rest/6.0/proposals/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Content-Length: 1104

{
  "Name": "testName",
  "Source": "salesforce_cpq",
  "Type": "acquisition",
  "Content": {
    "Language": "ro",
    "Currency": "ron",
    "LineItems": [
      {
        "ProductName": "Antivirus",
        "ProductCode": "FP10",
        "Quantity": 2,
        "Price": 54,
        "DiscountedPrice": 50.6,
        "PriceType": "gross",
        "PriceOptions": [],
        "AdditionalFields": [],
        "ImmediateAction": "now",
        "ContractPeriod": 0,
        "NextContractRenewalPeriod": 0,
        "MerchantDealAutoRenewal": false,
        "ClientDealAutoRenewal": false
      }
    ],
    "AdditionalFields": []
  },
  "BillTo": {
    "Company": "Randcomp",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "FirstRandcomp",
    "LastName": "Last Randcomp"
  },
  "SellTo": {
    "Company": "ReceiverCompany",
    "VatCode": "854234564",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "FR",
    "City": "Paris",
    "State": "Not",
    "Zip": "61321",
    "Address": "Rue du Elegance 43B",
    "FirstName": "Lucy",
    "LastName": "Lucky-Jean",
    "taxExemptionId": ""
  },
  "Tac": {
    "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
  },
  "Links": []
}

Create a proposal with type aquisitionCreate proposal with amendment and proration response example

{
  "ProposalId": "cd92f92b-1b41-4f36-b6c3-4f862c0ac550",
  "Name": "Renewal of antivirus",
  "SentBy": {
    "FirstName": "",
    "LastName": "",
    "Email": ""
  },
  "Version": 1,
  "CreatedDate": "2020-06-26T12:14:14+00:00",
  "UpdatedDate": "2020-06-26T12:14:14+00:00",
  "CreatedBy": "[email protected]",
  "Locked": false,
  "Source": "salesforce_cpq",
  "Type": "acquisition",
  "Status": "opened",
  "Content": {
    "Language": "ro",
    "Currency": "ron",
    "Terms": 1,
    "LineItems": [
      {
        "ProductName": "Antivirus",
        "ProductCode": "FP10",
        "Quantity": 2,
        "Price": 54.2,
        "DiscountedPrice": 50,
        "PriceType": "gross",
        "PriceOptions": [],
        "AdditionalFields": [],
        "ImmediateAction": "now",
        "ContractPeriod": 0,
        "NextContractRenewalPeriod": 0
      }
    ],
    "AdditionalFields": []
  },
  "BillTo": {
    "Company": "Randcomp",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe"
  },
  "SellTo": {
    "Company": "Randcomp",
    "VatCode": "85421564",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe",
    "TaxExemptionId": ""
  },
  "Tac": {
    "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
  },
  "Links": []
}

Retrieve a proposal

get

Retrieve a proposal

Path parameters

proposalIdstringRequired

The unique merchant proposal id

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

ProposalIdstringRequired

The unique merchant proposal id

Example: FDG123

VersionintegerRequired

The version of the proposal. Every modification increments the version by 1.

Example: 1

CreatedDatestring · date-timeRequired

The UTC creation date for the proposal in ISO 8601 format

Example: 2020-01-05T17:21:42Z

UpdatedDatestring · date-timeRequired

The UTC last update date for the proposal in ISO 8601 format

Example: 2020-01-05T17:21:42Z

CreatedBystringRequired

The unique external system user identifier

Example: [email protected]

UpdatedBystringRequired

The unique external system user identifier

Example: [email protected]

LockedbooleanRequired

If the proposal is locked for buy modifications

Example: false

SourcestringRequired

The source from where the proposal was created

Example: SALESFORCE_CPQ

NamestringRequired

The name of the proposal

Example: Renewal of antivirus

Typestring · enumRequired

The type of the proposal

Default: acquisitionExample: acquisitionPossible values:

Statusstring · enumRequired

The status of the proposal

Default: openedPossible values:

ExpirationDatestring · date-timeOptional

The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to "sent".

Example: 2020-01-05T17:21:42Z

StatusCommentstringRequired

The associated comment for the status

Example: The price is too high for the first product

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

get

/proposals/{proposalId}

HTTPcURLJavaScriptPython

GET /rest/6.0/proposals/{proposalId} HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "ProposalId": "cd92f92b-1b41-4f36-b6c3-4f862c0ac550",
  "Name": "Renewal of antivirus",
  "SentBy": {
    "FirstName": "",
    "LastName": "",
    "Email": ""
  },
  "Version": 1,
  "CreatedDate": "2020-06-26T12:14:14+00:00",
  "UpdatedDate": "2020-06-26T12:14:14+00:00",
  "CreatedBy": "[email protected]",
  "Locked": false,
  "Source": "salesforce_cpq",
  "Type": "amendment",
  "Status": "opened",
  "Content": {
    "Language": "ro",
    "Currency": "ron",
    "Terms": 30,
    "LineItems": [
      {
        "ProductName": "Antivirus",
        "ProductCode": "FP10",
        "Quantity": 2,
        "Price": 54.2,
        "DiscountedPrice": 50,
        "PriceType": "gross",
        "PriceOptions": [],
        "AdditionalFields": [],
        "ImmediateAction": "now",
        "ContractPeriod": 0,
        "NextContractRenewalPeriod": 0,
        "ProrationDate": "2020-01-04T12:32:22Z",
        "SubscriptionReference": "1234567890",
        "MerchantDealAutoRenewal": false,
        "ClientDealAutoRenewal": false,
        "AmendmentScenario": "prolong"
      }
    ],
    "AdditionalFields": []
  },
  "BillTo": {
    "Company": "Randcomp",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe"
  },
  "SellTo": {
    "Company": "Randcomp",
    "VatCode": "85421564",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe",
    "taxExemptionId": ""
  },
  "Tac": {
    "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
  },
  "Links": []
}

Update proposal

patch

Update proposal

Path parameters

proposalIdstringRequired

The unique merchant proposal id

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

Proposal update request

NamestringOptional

The name of the proposal

Example: Renewal of antivirus

UserIdstringOptional

The unique external system user identifier

Example: [email protected]

LockedbooleanOptional

If the proposal is locked for buy modifications

Example: false

Scopestring · enum · nullableOptional

Amendment scope, send only for amendments. Use null to reset on update.

Default: nullExample: autorenewalPossible values:

Responses

200

OK

application/json

ProposalIdstringRequired

The unique merchant proposal id

Example: FDG123

VersionintegerRequired

The version of the proposal. Every modification increments the version by 1.

Example: 1

CreatedDatestring · date-timeRequired

The UTC creation date for the proposal in ISO 8601 format

Example: 2020-01-05T17:21:42Z

UpdatedDatestring · date-timeRequired

The UTC last update date for the proposal in ISO 8601 format

Example: 2020-01-05T17:21:42Z

CreatedBystringRequired

The unique external system user identifier

Example: [email protected]

UpdatedBystringRequired

The unique external system user identifier

Example: [email protected]

LockedbooleanRequired

If the proposal is locked for buy modifications

Example: false

SourcestringRequired

The source from where the proposal was created

Example: SALESFORCE_CPQ

NamestringRequired

The name of the proposal

Example: Renewal of antivirus

Typestring · enumRequired

The type of the proposal

Default: acquisitionExample: acquisitionPossible values:

Statusstring · enumRequired

The status of the proposal

Default: openedPossible values:

ExpirationDatestring · date-timeOptional

The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to "sent".

Example: 2020-01-05T17:21:42Z

StatusCommentstringRequired

The associated comment for the status

Example: The price is too high for the first product

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch

/proposals/{proposalId}

HTTPcURLJavaScriptPython

PATCH /rest/6.0/proposals/{proposalId} HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 1391

{
  "ProposalId": "cd92f92b-1b41-4f36-b6c3-4f862c0ac550",
  "Name": "Renewal of antivirus",
  "SentBy": {
    "FirstName": "",
    "LastName": "",
    "Email": ""
  },
  "Version": 1,
  "CreatedDate": "2020-06-26T12:14:14+00:00",
  "UpdatedDate": "2020-06-26T12:14:14+00:00",
  "CreatedBy": "[email protected]",
  "Locked": false,
  "Source": "salesforce_cpq",
  "Type": "acquisition",
  "Status": "opened",
  "Content": {
    "Language": "ro",
    "Currency": "ron",
    "Terms": 1,
    "LineItems": [
      {
        "ProductName": "Antivirus",
        "ProductCode": "FP10",
        "Quantity": 2,
        "Price": 54.2,
        "DiscountedPrice": 50,
        "PriceType": "gross",
        "PriceOptions": [],
        "AdditionalFields": [],
        "ImmediateAction": "now",
        "ContractPeriod": 0,
        "NextContractRenewalPeriod": 0,
        "ProrationDate": "2020-01-04T12:32:22Z",
        "MerchantDealAutoRenewal": false,
        "ClientDealAutoRenewal": false
      }
    ],
    "AdditionalFields": []
  },
  "BillTo": {
    "Company": "Randcomp",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe"
  },
  "SellTo": {
    "Company": "Randcomp",
    "VatCode": "85421564",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe"
  },
  "Tac": {
    "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
  },
  "Links": []
}

Update proposal with type aquisitionProposal update with proration Date

{
  "ProposalId": "cd92f92b-1b41-4f36-b6c3-4f862c0ac550",
  "Name": "Renewal of antivirus",
  "SentBy": {
    "FirstName": "",
    "LastName": "",
    "Email": ""
  },
  "Version": 1,
  "CreatedDate": "2020-06-26T12:14:14+00:00",
  "UpdatedDate": "2020-06-26T12:14:14+00:00",
  "CreatedBy": "[email protected]",
  "Locked": false,
  "Source": "salesforce_cpq",
  "Type": "acquisition",
  "Status": "opened",
  "Content": {
    "Language": "ro",
    "Currency": "ron",
    "Terms": 1,
    "LineItems": [
      {
        "ProductName": "Antivirus",
        "ProductCode": "FP10",
        "Quantity": 2,
        "Price": 54.2,
        "DiscountedPrice": 50,
        "PriceType": "gross",
        "PriceOptions": [],
        "AdditionalFields": [],
        "ImmediateAction": "now",
        "ContractPeriod": 0,
        "NextContractRenewalPeriod": 0,
        "MerchantDealAutoRenewal": false,
        "ClientDealAutoRenewal": false
      }
    ],
    "AdditionalFields": []
  },
  "BillTo": {
    "Company": "Randcomp",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe"
  },
  "SellTo": {
    "Company": "Randcomp",
    "VatCode": "85421564",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "John",
    "LastName": "Doe",
    "TaxExemptionId": ""
  },
  "Tac": {
    "Content": "These terms and conditions outline the rules and regulations for the use of Company Name's Website, located at Website.com..."
  },
  "Links": []
}

Execute an action on the proposal

post

Execute an action on the proposal

Path parameters

proposalIdstringRequired

The unique merchant proposal id

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

Proposal action request

ExpirationDatestring · date-timeOptional

The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to "sent".

Example: 2020-01-05T17:21:42Z

UserIdstringOptional

The unique external system user identifier

Example: [email protected]

Actionstring · enumRequired

The action to perform. For feedback, the statusComment parameter is mandatory to be provided. For send, the expirationDate and sentBy parameters are mandatory to be provided. For send, reopen and discard it is recommended to provide the userId parameter. For decline is recommended to provide the statusComment parameter.

Possible values:

StatusCommentstringOptional

The associated comment for the status

Example: The price is too high for the first product

SendEmailbooleanOptional

used to skip sending notification email when set to false on sending or accepting a proposal

Default: true

Responses

200

OK

application/json

ProposalIdstringRequired

The unique merchant proposal id

Example: FDG123

VersionintegerRequired

The version of the proposal. Every modification increments the version by 1.

Example: 1

CreatedDatestring · date-timeRequired

The UTC creation date for the proposal in ISO 8601 format

Example: 2020-01-05T17:21:42Z

UpdatedDatestring · date-timeRequired

The UTC last update date for the proposal in ISO 8601 format

Example: 2020-01-05T17:21:42Z

CreatedBystringRequired

The unique external system user identifier

Example: [email protected]

UpdatedBystringRequired

The unique external system user identifier

Example: [email protected]

LockedbooleanRequired

If the proposal is locked for buy modifications

Example: false

SourcestringRequired

The source from where the proposal was created

Example: SALESFORCE_CPQ

NamestringRequired

The name of the proposal

Example: Renewal of antivirus

Typestring · enumRequired

The type of the proposal

Default: acquisitionExample: acquisitionPossible values:

Statusstring · enumRequired

The status of the proposal

Default: openedPossible values:

ExpirationDatestring · date-timeOptional

The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to "sent".

Example: 2020-01-05T17:21:42Z

StatusCommentstringRequired

The associated comment for the status

Example: The price is too high for the first product

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

post

/proposals/{proposalId}/action

HTTPcURLJavaScriptPython

POST /rest/6.0/proposals/{proposalId}/action HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 332

{
  "ExpirationDate": "2020-01-05T17:21:42Z",
  "UserId": "[email protected]",
  "Action": "decline",
  "StatusComment": "The price is too high for the first product",
  "SentBy": {
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "[email protected]"
  },
  "content": {
    "lineItems": [
      {
        "productCode": "FP10",
        "clientDealAutoRenewal": true
      }
    ]
  },
  "SendEmail": true
}

{
  "ProposalId": "56dc44d4-732a-4415-9c58-bce149aa9c7f",
  "Name": "testName",
  "SentBy": {
    "FirstName": "Marcus",
    "LastName": "Aurelius",
    "Email": "[email protected]"
  },
  "ExpirationDate": "2022-05-20T17:21:42+00:00",
  "Version": 3,
  "CreatedDate": "2020-06-26T12:15:52+00:00",
  "UpdatedDate": "2020-06-26T12:16:00+00:00",
  "CreatedBy": "[email protected]",
  "UpdatedBy": "",
  "Locked": false,
  "Source": "MERCHANT_API",
  "Type": "acquisition",
  "Status": "accepted",
  "StatusComment": "",
  "Content": {
    "Language": "ro",
    "Currency": "ron",
    "LineItems": [
      {
        "ProductName": "Antivirus",
        "ProductCode": "FP10",
        "Quantity": 2,
        "Price": 54,
        "DiscountedPrice": 50.6,
        "PriceType": "gross",
        "PriceOptions": [],
        "AdditionalFields": [],
        "ImmediateAction": "now",
        "ContractPeriod": 0,
        "NextContractRenewalPeriod": 0,
        "ProrationDate": "2020-01-04T12:32:22Z",
        "MerchantDealAutoRenewal": false,
        "ClientDealAutoRenewal": false
      }
    ],
    "AdditionalFields": []
  },
  "BillTo": {
    "Company": "Randcomp",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "Marcus",
    "LastName": "Aurelius"
  },
  "SellTo": {
    "Company": "Randcomp",
    "VatCode": "85421564",
    "Phone": "12172196850",
    "Email": "[email protected]",
    "Country": "US",
    "City": "Carthage",
    "State": "Illinois",
    "Zip": "62321",
    "Address": "1849  Cardinal Lane",
    "FirstName": "Marcus",
    "LastName": "Aurelius",
    "taxExemptionId": ""
  },
  "Tac": {
    "Content": "phase7",
    "AcceptedDate": "2020-06-26T12:16:00+00:00"
  },
  "Links": [
    {
      "LinkId": "8e5c039e-106e-44bd-893a-d0d0276b0587",
      "Url": "https://proposal.2checkout.com/merchant-code/test/link-id/8e5c039e-106e-44bd-893a-d0d0276b0587",
      "Status": "sent"
    },
    {
      "LinkId": "7b9fb5fa-6aaa-42e5-aee2-afef873c495a",
      "Url": "https://proposal.2checkout.com/merchant-code/test/link-id/7b9fb5fa-6aaa-42e5-aee2-afef873c495a",
      "Status": "accepted"
    }
  ]
}