Creates Delivery Checkout configurations from existing configurations.

Sections in this article:

• Fetch Delivery Checkout configurations
• Fetch a Delivery Checkout configuration
• Create a Delivery Checkout configuration
• Update a Delivery Checkout configuration
• Fetch Delivery Checkout status
• Update Delivery Checkout status

Fetch Delivery Checkout configurations

GET /delivery-checkout-configurations

Fetches a list of all Delivery Checkout configurations on an account.

Response example

{
  "configurations": [
    {
      "id": "05461a99-0c6b-4c3a-8aaf-90caaefaa3fe",
      "name": "Delivery checkout 1",
      "description": "",
      "active": true,
      "subVersion": 0
    },
    {
      "id": "9cf592aa-a7dc-4490-b8fd-9436cf872016",
      "name": "Delivery checkout 2",
      "description": "",
      "active": true,
      "subVersion": 0
    }
  ]
}

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-configurations GET.

Fetch a Delivery Checkout configuration

GET /delivery-checkout-configurations/{deliveryCheckoutId}

Fetches a Delivery Checkout configuration.

Always use the complete Delivery Checkout ID since the Delivery Checkout version is included in the ID.

URI parameters

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-configurations/{deliveryCheckoutId} GET.

Create a Delivery Checkout configuration

POST /delivery-checkout-configurations

Create a new Delivery Checkout configuration from an exported configuration. Use exported JSON content as body. A new Delivery Checkout ID is created and the Delivery Checkout will be activated after import.

Response example

{
  "id": "05461a99-0c6b-4c3a-8aaf-90caaefaa3fe+0",
  "name": "Name",
  "description": "Description",
  "active": true,
  "subVersion": 0
}

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-configurations POST.

Update a delivery checkout configuration

PUT /delivery-checkout-configurations/{deliveryCheckoutId}

Updates a Delivery Checkout configuration to a new version.

It will not change the active status on the versions. 

Always use the complete Delivery Checkout ID since the Delivery Checkout version is included in the ID.

URI parameters

Response example

{
  "id": "05461a99-0c6b-4c3a-8aaf-90caaefaa3fe+1",
  "name": "Name",
  "description": "Description",
  "active": true,
  "subVersion": 1
}

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-configurations/{deliveryCheckoutId} PUT.

Fetch Delivery Checkout status

GET /delivery-checkout-configurations/{deliveryCheckoutId}/status

Fetches a Delivery Checkout active status.

Always use the complete Delivery Checkout ID since the Delivery Checkout version is included in the ID.

URI parameters

Response example

{
  "active": true
}

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-configurations/{deliveryCheckoutId}/status GET.

Update Delivery Checkout status

PUT /delivery-checkout-configurations/{deliveryCheckoutId}/status

Updates a Delivery Checkout status.

Always use the complete Delivery Checkout ID since the Delivery Checkout version is included in the ID.

URI parameters

Body example

{
  "active": false
}

Response example

{
  "active": true
}

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-configurations/{deliveryCheckoutId}/status PUT.