• Manage integration configurations
  • getGet Configuration
  • patchUpdate Configuration

API docs by Redocly

Integration Configurations (1.0)

Download OpenAPI specification:Download

Use this API to manage integration configurations. For now, it supports Third Party Promotion Engine (TPPE).

Manage integration configurations

Manage integration configurations

Get Configuration

Retrives integration configurations.

Authorizations:

newStoreAccessToken

path Parameters

section-id required

string Value: "tppe" The id of the section to be configured.

Responses

The staging server

/promotions/configurations/{section-id}

The production server

/promotions/configurations/{section-id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "session_update_url": "http://abc.cloudhub.io/promotion/cart-session/{customerSessionId}"

}

Update Configuration

Updates integration configuration.

Authorizations:

newStoreAccessToken

path Parameters

section-id required

string Value: "tppe" The id of the section to be configured.

Request Body schema: application/json

One of

session_update_url	string Session Update URL. The URL that will be called each time the order gets updated in NewStore's Associate App. The URL has to end with the placeholder {customerSessionId} that will be replaced with the cart ID/order ID.
auth_token	string The auth token that will be used as Bearer token for the authentication with the third party integration APIs. It can be empty.

Responses

The staging server

/promotions/configurations/{section-id}

The production server

/promotions/configurations/{section-id}

Request samples

• Payload

Content type

application/json

{

• "session_update_url": "http://abc.cloudhub.io/promotion/cart-session/{customerSessionId}",
• "auth_token": "test-auth-token"

}

Response samples

• 400
• 500

Content type

application/json

Example

Example 1Example 2Example 1

{

• "message": "not found",
• "status": 404

}