Skip to main content
API docs by Redocly

API to get, create and update NOM configurations (0.1.0)

Download OpenAPI specification:Download

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

Use these APIs to get, create and update NOM configurations

Get NOM release toggles

Retrieves the release toggles for various features within NewStore Omnichannel Manager set up for the retailer.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_at": "2021-07-13T20:18:25Z"
}

Set NOM release toggles

Sets release toggles for various features within NewStore Omnichannel Manager for the retailer. This action overwrites any existing configuration and doesn't allow for partial updates.

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

Defines if swapping products within the remorse period is activated in NOM, defaults to false.

showOfflineOrders
boolean
Default: false

Define if the offline orders tab is displayed and offline orders are visible or not, defaults to false.

showRequestRefund
boolean
Default: false

Defines if order refunds or appeasements are activated in NOM, defaults to false.

showProductId
boolean
Default: false

Defines if the Product ID is shown in Stock Levels and Mispicked Stock views, CSV export on the Product Stock view, defaults to false.

enableItemSwapAfterGracePeriod
boolean
Default: false

Defines if item swap is visible or not in the list of actions that can be applied to a product when handling an exception for an on hold order.

enableManualRouting
boolean
Default: false

Defines if manual routing is visible or not in the list of actions that can be applied to a product when handling an exception for an on hold order.

viewOMSettings
boolean
Default: false

If true, users with the required permissions will have access to edit their order management settings in NOM.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_at": "2021-07-13T20:18:25Z"
}

Retrieve order tracking URLs config for NOM.

Retrieves the order tracking URLs for NewStore Omnichannel Manager.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{}

Set NOM order tracking URLs

Sets the order tracking URLs for NewStore Omnichannel Manager. This action overwrites any existing configuration and doesn't allow for partial updates.

Important: The shipping carrier must be provided in lower case. For example, if you wish to provide a custom tracking URL for USPS, use usps as key.

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

This value contains the order tracking url configurations.

additionalProperties
object

The key of this object is the shipping carrier such as DHL or FedEx. The value is the URL to the tracking website of the shipping carrier.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/problem+json
{}

Get order export configuration

Retrieves the configuration for an order export via NewStore Omnichannel Manager.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_at": "2021-07-13T20:18:25Z"
}

Create order export configuration

Creates the configuration to enable order exports via NewStore Omnichannel Manager. This action overwrites any existing configuration and doesn't allow for partial updates.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
required
object
Array of objects non-empty

Defines an array of extended order attributes which can be shown inside order export.

Array of objects non-empty

Defines an array of extended order item attributes which can be shown inside order export.

Array of objects non-empty
Default: [{"label":"SKU","name":"sku"},{"label":"EAN13","name":"ean13"}]

Defines an array of external order item identifiers which can be shown inside order export.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_at": "2021-07-13T20:18:25Z"
}

List extended order attributes

Retrieves an array of extended order attributes which can be shown on the order detail page in NewStore Omnichannel Manager. For more information on the extended attributes, see this section.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "updated_at": "2021-07-13T20:18:25Z"
}

Create extended order attributes

Creates an array of extended order attributes which can be shown on the order detail page in NewStore Omnichannel Manager. For more information on the extended attributes, see this section. This action overwrites any existing configuration and doesn't allow for partial updates.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
required
object
display
string
Enum: "badge" "string" "url"

Defines the way the extended order attribute will be shown in NOM. Either as 'badge', simple 'string' or link if set to 'url'.

label
string

The string to be shown in NOM for this extended order attribute.

name
string

The system name of the extended order attribute. Must match the name used for the extended order attribute used in the order.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "updated_at": "2021-07-13T20:18:25Z"
}