Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/newstore-routing-config-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: '1.0'
title: NewStore Routing Config API
description: NewStore public APIs
contact:
email: support@newstore.com
name: NewStore API Support
url: https://developer.newstore.com
servers:
- url: https://dodici-demo.p.newstore.net/
security: []
tags:
- name: routing-config
description: Routing Configuration
paths:
/v0/config/routing/can_update_ffr_processed_externally:
get:
description: 'Retrieves the current configuration to determine if you can update
the status for fulfillment requests that were processed outside of the NewStore platform,
because of possible issues with fulfillment or shipping status updates.
For more information, see the
[guide](https://docs.newstore.com/docs/monitoring-orders#updating-the-shipment-status-for-external-orders).
'
summary: showExternalFulfillmentSettings
tags:
- routing-config
operationId: showExternalFulfillmentSettings
deprecated: false
responses:
default:
description: Unexpected error.
headers: {}
'200':
description: Successfully retrieved the config value
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalFulfillmentSettingsResponse'
application/problem+json:
schema:
$ref: '#/components/schemas/ExternalFulfillmentSettingsResponse'
'404':
description: Config key doesn't exist (it is not a case when key exists but just not set).
headers: {}
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: 'Enables the configuration to allow you to update
the status for fulfillment requests that were processed outside of the NewStore platform,
because of possible issues with fulfillment or shipping status updates.
For more information, see the
[guide](https://docs.newstore.com/docs/monitoring-orders#updating-the-shipment-status-for-external-orders).
'
summary: createExternalFulfillmentSettings
tags:
- routing-config
operationId: createExternalFulfillmentSettings
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Unexpected error.
headers: {}
'200':
description: Successfully saved config value
headers: {}
'400':
description: Incorrect payload for config (validation failed).
headers: {}
'409':
description: Cannot update the configuration due to a potential race condition. Please retry.
headers: {}
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalFulfillmentSettingsRequest'
/v0/config/routing/cancel_on_conflict:
get:
description: '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](/developers/configuration/config-insuff-inv).
'
summary: showCancellationPolicySettings
tags:
- routing-config
operationId: showCancellationPolicySettings
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully retrieved.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CancellationPolicySettings'
application/problem+json:
schema:
$ref: '#/components/schemas/CancellationPolicySettings'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: '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](/developers/configuration/config-insuff-inv).
'
summary: createCancellationPolicySettings
tags:
- routing-config
operationId: createCancellationPolicySettings
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully updated.
headers: {}
'400':
description: Bad request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancellationPolicySettings'
/v0/config/routing/enable_automatic_rerouting:
get:
description: 'Retrieves the current configuration that determines if on hold orders are routed to
fulfillment locations automatically when stock becomes available in these locations.
'
summary: showAutomaticReroutingSetting
tags:
- routing-config
operationId: showAutomaticReroutingSetting
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully retrieved.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AutomaticReroutingSettings'
application/problem+json:
schema:
$ref: '#/components/schemas/AutomaticReroutingSettings'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: 'Sets the configuration that determines if on hold orders are routed to
fulfillment locations automatically when stock becomes available in these locations.
'
summary: createAutomaticReroutingSetting
tags:
- routing-config
operationId: createAutomaticReroutingSetting
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully updated.
headers: {}
'400':
description: Bad request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AutomaticReroutingSettings'
/v0/config/routing/enable_capacity_based_routing:
get:
description: 'Retrieves the current configuration that determines if orders are routed to fulfillment locations based on a capacity aware algorithm.
'
summary: showCapacityBasedRoutingSettings
tags:
- routing-config
operationId: showCapacityBasedRoutingSettings
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Succesfully returning the value of the capacity based routing toggle
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityBasedRoutingSettings'
application/problem+json:
schema:
$ref: '#/components/schemas/CapacityBasedRoutingSettings'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: An internal error occurred.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: 'Sets the current configuration that determines if orders are routed to
fulfillment locations based on a capacity aware algorithm.
'
summary: createCapacityBasedRoutingSettings
tags:
- routing-config
operationId: createCapacityBasedRoutingSettings
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully updated.
headers: {}
'400':
description: Bad request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityBasedRoutingSettings'
required: true
/v0/config/routing/reroute_to_rejected_fulfillment_nodes:
get:
description: '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.
'
summary: showRejectedReroutingSettings
tags:
- routing-config
operationId: showRejectedReroutingSettings
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully retrieved.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RejectedReroutingSettings'
application/problem+json:
schema:
$ref: '#/components/schemas/RejectedReroutingSettings'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: '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.
'
summary: createRejectedReroutingSettings
tags:
- routing-config
operationId: createRejectedReroutingSettings
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully updated.
headers: {}
'400':
description: Bad request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RejectedReroutingSettings'
/v0/config/routing/skip_shipping_offer_update_for_dc_orders:
get:
description: '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.
'
summary: showShippingOfferUpdateSettings
tags:
- routing-config
operationId: showShippingOfferUpdateSettings
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully retrieved.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ShippingOfferUpdateSettings'
application/problem+json:
schema:
$ref: '#/components/schemas/ShippingOfferUpdateSettings'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: '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``.
'
summary: createShippingOfferUpdateSettings
tags:
- routing-config
operationId: createShippingOfferUpdateSettings
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully updated.
headers: {}
'400':
description: Bad request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShippingOfferUpdateSettings'
/v0/config/routing/uses_external_atp:
get:
description: '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](/product/processes/about-ffment/#external-oms-config).
If not set or set to ``false``, NewStore retrieves ATP based on
the stock on hand) for the products.
'
summary: showExternalAtpSettings
tags:
- routing-config
operationId: showExternalAtpSettings
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully retrieved.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAtpSettings'
application/problem+json:
schema:
$ref: '#/components/schemas/ExternalAtpSettings'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
post:
description: '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](/product/processes/about-ffment/#external-oms-config).
If not set or set to ``false``, NewStore retrieves ATP based on
the stock on hand for the products.
'
summary: createExternalAtpSettings
tags:
- routing-config
operationId: createExternalAtpSettings
deprecated: false
parameters:
- name: Content-Type
in: header
required: false
description: ''
schema:
type: string
enum:
- application/json
responses:
default:
description: Default response
headers: {}
'200':
description: Value was successfully updated.
headers: {}
'400':
description: Bad request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'429':
description: Too Many Requests
headers:
Retry-After:
schema:
type: string
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal server error.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'502':
description: Bad Gateway
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'503':
description: Service Unavailable
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
security:
- oauth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAtpSettings'
/v0/routing/shipments_limit:
get:
description: 'List all shipments limits. This method is limited to return a maximum of 10.000 shipments limits per tenant.
'
summary: listShipmentLimits
tags:
- routing-config
operationId: listShipmentLimits
deprecated: false
responses:
default:
description: Default response
headers: {}
'200':
description: Succesfully returning list of shipments limits
headers: {}
content:
application/json:
schema:
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/newstore/refs/heads/main/openapi/newstore-routing-config-api-openapi.yml