Skip to main content
API docs by Redocly

Availability Config API (0.1.0)

Download OpenAPI specification:Download

team-order-management: team-order-management@newstore.com

Use this API when ATP information needs to be retrieved from an external order management system.

Get webhook configuration

Retrieves the current configuration for requesting ATP information from the external order management system.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "url": "https://lambda.com/",
  • "api_key": "962b5dfbc57da5448cb4",
  • "external_identifier": "product_id",
  • "timeout": 15
}

Update webhook configuration

Specify that the retailer will use an external order management system for using ATP information.

If you want to disable using ATP information from the external OMS, please delete the configuration.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
url
required
string <uri> non-empty

Describes the URL being called from the platform.

api_key
required
string >= 20 characters

Describes API key used for authenticating requests.

external_identifier
required
string non-empty

Describes identifier being used by an integration to look up ATP information in an external system. Currently only 'product_id' is supported.

timeout
required
integer [ 5 .. 60 ]

Defines the timeout for HTTP requests.

Responses

Request samples

Content type
application/json
{
  • "url": "https://lambda.com/",
  • "api_key": "962b5dfbc57da5448cb4",
  • "external_identifier": "product_id",
  • "timeout": 15
}

Response samples

Content type
application/json
{
  • "url": "https://lambda.com/",
  • "api_key": "962b5dfbc57da5448cb4",
  • "external_identifier": "product_id",
  • "timeout": 15
}

Delete webhook configuration

Deletes the current configuration for requesting ATP information from the external order management system.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/problem+json
{
  • "error_code": "internal_server_error",
  • "message": "The request didn't succeed.",
  • "request_id": "ec2f3c9bb016ba971bf6074098363"
}