Ctrlk
Sign up for free
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Proposal History

Search proposal versions

get

Search proposal versions

Path parameters
proposalIdstringRequired

The unique merchant proposal id

Query parameters
Pageinteger · max: 9999Required

The page at which the proposal versions should be returned

Default: 0
Limitinteger · min: 1 · max: 100Required

The maximum number of proposal versions to return

Default: 10
HasStatusCommentstringOptional

Filters the history version by statusComment field. It can be "true" or "false"

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
countintegerRequired

The total number of proposal versions matching the criterias

Example: 1
get/proposals/{proposalId}/history
GET /rest/6.0/proposals/{proposalId}/history?Page=0&Limit=10 HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: text
200

OK

{
  "Versions": [
    {
      "ProposalId": "2c0a8b3a-54fe-4ff9-ac19-a48e49d90298",
      "Name": "testName",
      "SentBy": {
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "Email": "marcus.aurelius@sharklasers.io"
      },
      "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": "john.doe@customer.com",
      "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
          }
        ],
        "AdditionalFields": []
      },
      "BillTo": {
        "Company": "Randcomp",
        "Phone": "12172196850",
        "Email": "y2hzhca4pc@groupbuff.com",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius"
      },
      "SellTo": {
        "Company": "Randcomp",
        "VatCode": "85421564",
        "Phone": "12172196850",
        "Email": "y2hzhca4pc@groupbuff.com",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "taxExemptionId": ""
      },
      "Tac": {
        "Content": "phase7",
        "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": "2c0a8b3a-54fe-4ff9-ac19-a48e49d90298",
      "Name": "testName",
      "SentBy": {
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "Email": "marcus.aurelius@sharklasers.io"
      },
      "ExpirationDate": "2022-05-20T17:21:42+00:00",
      "Version": 2,
      "CreatedDate": "2020-06-26T11:35:04+00:00",
      "UpdatedDate": "2020-06-26T11:35:13+00:00",
      "CreatedBy": "john.doe@customer.com",
      "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
          }
        ],
        "AdditionalFields": []
      },
      "BillTo": {
        "Company": "Randcomp",
        "Phone": "12172196850",
        "Email": "y2hzhca4pc@groupbuff.com",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius"
      },
      "SellTo": {
        "Company": "Randcomp",
        "VatCode": "85421564",
        "Phone": "12172196850",
        "Email": "y2hzhca4pc@groupbuff.com",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "taxExemptionId": ""
      },
      "Tac": {
        "Content": "phase7",
        "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": "2c0a8b3a-54fe-4ff9-ac19-a48e49d90298",
      "Name": "testName",
      "SentBy": {
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "Email": "marcus.aurelius@sharklasers.io"
      },
      "ExpirationDate": "2022-05-20T17:21:42+00:00",
      "Version": 1,
      "CreatedDate": "2020-06-26T11:35:04+00:00",
      "UpdatedDate": "2020-06-26T11:35:13+00:00",
      "CreatedBy": "john.doe@customer.com",
      "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
          }
        ],
        "AdditionalFields": []
      },
      "BillTo": {
        "Company": "Randcomp",
        "Phone": "12172196850",
        "Email": "y2hzhca4pc@groupbuff.com",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius"
      },
      "SellTo": {
        "Company": "Randcomp",
        "VatCode": "85421564",
        "Phone": "12172196850",
        "Email": "y2hzhca4pc@groupbuff.com",
        "Country": "US",
        "City": "Carthage",
        "State": "Illinois",
        "Zip": "62321",
        "Address": "1849  Cardinal Lane",
        "FirstName": "Marcus",
        "LastName": "Aurelius",
        "taxExemptionId": ""
      },
      "Tac": {
        "Content": "phase7",
        "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"
        }
      ]
    }
  ],
  "Page": 1,
  "Limit": 100,
  "Count": 3,
  "PagesCount": 1
}

Retrieve a proposal version

get

Retrieve a proposal version

Path parameters
proposalIdstringRequired

The unique merchant proposal id

versionNumberinteger · min: 1Required

The proposal version

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: john.doe@customer.com
UpdatedBystringRequired

The unique external system user identifier

Example: john.doe@customer.com
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
get/proposals/{proposalId}/history/{versionNumber}
GET /rest/6.0/proposals/{proposalId}/history/{versionNumber} HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: text

[
  {
    "ProposalId": "2c0a8b3a-54fe-4ff9-ac19-a48e49d90298",
    "Name": "testName",
    "SentBy": {
      "FirstName": "Marcus",
      "LastName": "Aurelius",
      "Email": "marcus.aurelius@sharklasers.io"
    },
    "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": "john.doe@customer.com",
    "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
        }
      ],
      "AdditionalFields": []
    },
    "BillTo": {
      "Company": "Randcomp",
      "Phone": "12172196850",
      "Email": "y2hzhca4pc@groupbuff.com",
      "Country": "US",
      "City": "Carthage",
      "State": "Illinois",
      "Zip": "62321",
      "Address": "1849  Cardinal Lane",
      "FirstName": "Marcus",
      "LastName": "Aurelius"
    },
    "SellTo": {
      "Company": "Randcomp",
      "VatCode": "85421564",
      "Phone": "12172196850",
      "Email": "y2hzhca4pc@groupbuff.com",
      "Country": "US",
      "City": "Carthage",
      "State": "Illinois",
      "Zip": "62321",
      "Address": "1849  Cardinal Lane",
      "FirstName": "Marcus",
      "LastName": "Aurelius",
      "taxExemptionId": ""
    },
    "Tac": {
      "Content": "phase7",
      "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"
      }
    ]
  }
]
PreviousProposal
NextRenewal

Last updated

Was this helpful?