Skip to main content

Order Injection configuration (1.0.0)

Download OpenAPI specification:Download

Use this API to configure and manage order injection process in the NewStore platform.

For more information, see the [configuration guide](/docs/development/configuration/config-order injection.html#configuring-order injection-operations).

Order Injection configuration

Injection configuration

Get order injection configuration

Retrieves the current order injection configuration set up for your business. The response payload also contains the current version of the configuration, the timestamp when it was last updated, and who updated it.

Authorizations:
newStoreAccessToken
header Parameters
request_id
string
tenant
required
string
user-id
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "version": "string",
  • "updated_at": "2021-12-31T23:59:59Z",
  • "updated_by": "string"
}

Update order injection configuration

Updates the current order injection configuration for your business.

Authorizations:
newStoreAccessToken
query Parameters
version
string
header Parameters
request_id
string
tenant
required
string
user-id
string
Request Body schema: application/json

The updated config value

object

The order item limits that determine if the order is routed or is considered a big order and placed on hold.

skip_soft_routing_on_injection
boolean

When set to true, do not do the soft routing for injected orders with a service level identifier.

Responses

Request samples

Content type
application/json
{
  • "big_sales_order": {
    },
  • "skip_soft_routing_on_injection": true
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "version": "string",
  • "updated_at": "2021-12-31T23:59:59Z",
  • "updated_by": "string"
}

Replace order injection configuration

Use this method to create a new order injection configuration and completely replace the current configuration for your business.

Authorizations:
newStoreAccessToken
query Parameters
version
string
header Parameters
request_id
string
tenant
required
string
user-id
string
Request Body schema: application/json

The updated config value

object

The order item limits that determine if the order is routed or is considered a big order and placed on hold.

skip_soft_routing_on_injection
boolean

When set to true, do not do the soft routing for injected orders with a service level identifier.

Responses

Request samples

Content type
application/json
{
  • "big_sales_order": {
    },
  • "skip_soft_routing_on_injection": true
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "version": "string",
  • "updated_at": "2021-12-31T23:59:59Z",
  • "updated_by": "string"
}