Skip to main content
API docs by Redocly

Logistic Order configuration API (v0)

Download OpenAPI specification:Download

Get order cancelation policies

Retrieves the configuration based on which it is determined if orders in your business are canceled automatically in case of a conflict.

The configuration also contains the reasons for which orders can be canceled automatically. For more information about the properties, see the guide.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_at": "2021-08-23T12:54:10.381175Z"
}

Set order cancelation policies

Sets the configuration based on which it is determined if orders in your business are canceled automatically in case of a conflict.

The configuration also contains the reasons for which orders can be canceled automatically. For more information about the properties, see the guide.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
required
object

Order cancellation policies.

default
boolean
Default: true

Determines whether orders are canceled automatically in case of a conflict.

reasons_to_overwrite_default
Array of strings non-empty
Items Enum: "insufficient_stock" "failed_fulfillment_node_mapping" "shipping_offer_update_error" "error" "not_enough_stock_to_create_allocation"

A list of reasons to prevent an automatic cancelation of an order (in case default is 'true') or to prevent an order being in the conflict state.

Responses

Request samples

Content type
application/json
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "request_id": "string"
}

Get automatic routing config for on hold orders

Retrieves the current configuration that determines if on hold orders are routed to fulfillment locations automatically when stock becomes available in these locations.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": true,
  • "updated_at": "2021-08-23T12:54:05.721904Z"
}

Enable automatic routing config for on hold orders

Sets the configuration that determines if on hold orders are routed to fulfillment locations automatically when stock becomes available in these locations.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
value
required
boolean

Tenant-based release toggle for the automatic rerouting feature in order to roll it out on a per tenant basis.

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "request_id": "string"
}

Get automatic routing config for orders to fulfillment locations

Retrieves the configuration that determines if orders will be automatically routed to fulfillment locations where stock has become available, even if these locations had rejected the order fulfillment request earlier, due to insufficient stock at these locations.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": true,
  • "updated_at": "2021-08-23T12:54:05.721904Z"
}

Enable automatic routing config for orders to fulfillment locations

Sets the configuration that determines if orders will be automatically routed to fulfillment locations where stock has become available, even if these locations had rejected the order fulfillment request earlier, due to insufficient stock at these locations.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
value
required
boolean

Tells the routing engine if it should ignore fulfillment nodes that already rejected the fulfillment request at hand.

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "request_id": "string"
}

Get shipping offer update config for DC orders

Retrieves the current configuration, which determines if NewStore skips updating shipping offers when orders are routed to a warehouse or DC for fulfillment. By default, this is set to true.

We recommend setting this configuration to true.

Please be aware that having this value set to true can cause a fulfillment request routed to DC to have an empty shipping provider field if the tenant is also configured, skipping soft routing on an order injection.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": true,
  • "updated_at": "2021-08-23T12:54:05.721904Z"
}

Skip shipping offer updates for DC orders

Sets the configuration that allows NewStore to skip updating shipping offers when orders are routed to a warehouse or DC for fulfillment.

We recommend setting this configuration to true.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
value
required
boolean

Determines whether an order routed to a DC needs a shipping offer update.

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "request_id": "string"
}

Get config to request external ATP data

Specifies if ATP is requested from an external source or from NewStore.

If set to true, NewStore uses ATP from an external availability source such as an external OMS. If not set or set to false, NewStore retrieves ATP based on the stock on hand) for the products.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": true,
  • "updated_at": "2021-08-23T12:54:05.721904Z"
}

Enable config to request external ATP data

Specifies if ATP is requested from an external source or from NewStore.

If set to true, NewStore uses ATP from an external availability source such as an external OMS. If not set or set to false, NewStore retrieves ATP based on the stock on hand for the products.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
value
required
boolean

If true, use availability service to request ATP data; otherwise use unallocated items count.

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "request_id": "string"
}

List shipments limits

List all shipments limits. This method is limited to return a maximum of 10.000 shipments limits per tenant.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "shipments_limit": [
    ]
}

Update or create a shipment limit

Upsert a shipment limit for a (currency,service_level) pair.

An order will be marked as a conflict if any limit on limit_exceeded_when is reached.

It is not allowed to have two limits with the same shipment_count_gt value.

The order_amount_lt of a given limit should be greater than or equal to others limits with smaller shipment_count_gt.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
currency
required
string = 3 characters

Currency alpha code in ISO 4217 format. Per example USD, EUR or JPY

service_level
required
string

Shipping service level

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "currency": "USD",
  • "service_level": "EVERYDAY",
  • "limit_exceeded_when": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": "invalid_input_data",
  • "message": "order_amount_lt of shipment_count_gt=2 must greater of equal 300 USD.",
  • "request_id": "ec2f3c9bb016ba971bf6074098363"
}

Enable capacity based routing feature

Retrieves the current configuration that determines if orders are routed to fulfillment locations based on a capacity aware algorithm.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": true,
  • "updated_at": "2021-08-23T12:54:05.721904Z"
}

Update capacity based routing feature toggle

Sets the current configuration that determines if orders are routed to fulfillment locations based on a capacity aware algorithm.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
value
required
boolean

Tenant-based release toggle for the feature of capacity-based routing.

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "request_id": "string"
}

Get routing insights

Get insights on routing and shipment details for orders being processed in the NewStore platform. This includes details such as:

  • Items in the order
  • The fulfillment location that is assigned to fulfill orders
  • The time when the shipment was dispatched from the fulfillment location
  • Order routing strategies
  • Service levels
Authorizations:
newStoreAccessToken
path Parameters
order_id
required
string

A sales order UUID or external order ID

Responses

Response samples

Content type
application/json
{
  • "insights": {
    }
}