Sign in
offer

showCheckoutStatus offer

Changed on

Show the offer status and the checkout requirements of an offer owned by the authenticated user

get/offers/{id}/checkout-status

Request

  • Base URL: https://api.topi-staging.eu
  • URL: https://api.topi-staging.eu/offers/{id}/checkout-status
  • Auth: OAuth 2 (authorization code, authorization URL /oauth2/authorize, token URL /oauth2/token, scopes: offer:read)

Path parameters

idstring regexp required

Offer ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Response

OK response.

offer_statusstring required

The raw offer status as stored, unmapped; the client decides how to present each value

Example response

{
  "checkout_requirements": [
    {
      "dependencies": [
        "contract_signing"
      ],
      "logo_url": "https://example.com/foo",
      "provider": "docusign",
      "status": "required",
      "type": "contract_signing",
      "url": "https://example.com/foo"
    }
  ],
  "offer_status": "abc123"
}

Changes