This is the main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.

User Guide:NewStore Connector Guide
Release Notes: NewStore Release Notes

Configurations

Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

Connection

The connection types that can be provided to this configuration.

x 

Object Store

ObjectStore

 

Name

String

The identifier of this element used to reference it in other components

x 

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Connection
Parameters
Name Type Description Default Value Required

Connection Parameters

New Store Connection Parameters

x 

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

 

Pooling Profile

Pooling Profile

Characteristics of the connection pool

 

Associated Operations

Operations

Accept Fulfillment Request

<newstore:accept-fulfillment-request>

Integration APIs > Order Management > Fulfillment Provider API > Accept fulfillment request Accepts a fulfillment request. Acceptance indicates intent to fulfill. Note: This only applies to orders routed to a DC or warehouse for fulfillment.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Cancel Fulfillment Request Items

<newstore:cancel-fulfillment-request-items>

Integration APIs > Order Management > Fulfillment Provider API > Cancel items

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Cancel Items Payload

Any

A list of product IDs, e.g. SKU that will be canceled.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Adjustment

<newstore:create-adjustment>

Integration APIs > Inventory Management > Inventory Manager API > Create adjustment Creates an adjustment

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Adjustment Payload

Any

Adjustment reason object to create.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Adjustment Reason

<newstore:create-adjustment-reason>

Integration APIs > Inventory Management > Inventory Manager API > Create adjustment reason Creates an adjustment reason, which can be used across all stores configured for your business.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Adjustment Reason Payload

Any

Adjustment reason object to create.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Advance Ship Notice

<newstore:create-advance-ship-notice>

Integration APIs > Inventory Management > Inventory Manager > Receiving > Create ASN Creates an ASN against which items can be received into the store’s stock on hand.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Asn Payload

Any

An object containing the from location, the fulfillment node id, a list of items, the references and the shipment date.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Count Task

<newstore:create-count-task>

Integration APIs > Inventory Management > Inventory Manager API > Create count task Creates a count task for the specified store. If you use NewStore as inventory master for your business, use this method to create a count task to count the items in a specific stock location.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

The store identifier. Use the List stores method to get the ID.

x 

Count Task Payload

Any

Object containing the due data, the external id, a list of products ids and the stock location.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Fulfillment Location Group

<newstore:create-fulfillment-location-group>

Order Management > Availabilities Export > Create fulfillment location group Creates a group of fulfillment locations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Fulfillment Location Group Payload

Any

Object with fulfilment group name and the list of fulfillment nodes.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Instore Pickup Config

<newstore:create-instore-pickup-config>

Integration APIs > Store fulfillment > In-store Pickup API > Create in-store pickup config Creates the initial in-store pickup config for all stores in your business. Overrides all existing global and store-specific config values. Important: The default_search_radius property is in kilometers.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Pickup Config Payload

Any

An object containing the global configuration and the stores.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Instore Pickup Config For Store

<newstore:create-instore-pickup-config-for-store>

Integration APIs > Store fulfillment > In-store Pickup API > Create in-store pickup config for store Creates a new pickup config for the store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

The store identifier.

x 

Create Store Pickup Config Payload

Any

Object containing the delivery time, delivery time to when is available and the cost.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Item Note

<newstore:create-item-note>

Integration APIs > Order Management > Order Notes API > Create item note Creates a new note that applies to the item ID specified in the request URL. For example, create a note for an item that a customer wants to cancel after purchasing it in the store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Uuid

String

Unique ID for an order.

x 

Item Uuid

String

Unique ID for an item in an order.

x 

Note Payload

Any

Object containing the note.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Or Update Transfer Shipping Config

<newstore:create-or-update-transfer-shipping-config>

Integration APIs > Inventory Management > Inventory Manager API > Create or update transfer shipping configuration Creates or updates a transfer shipping configuration, used for shipping transfer orders. A transfer order is used to send inventory from a store to another location (DC or store). When you update the configuration using this method, the response body contains the revision of the configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transfer Shipping Config Payload

Any

A list of transfer shipping configurations.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Order

<newstore:create-order>

Integration APIs > Order Management > Order Injection API > Create order Creates an order in NewStore by importing an order placed via an external system. This is also referred as injecting an order. Each request creates a single order in NewStore.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Order Payload

Any

An object containing an order.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Order Note

<newstore:create-order-note>

Integration APIs > Order Management > Order Notes API > Create order note Creates a new note that applies to the order ID specified in the request URL. For example, create a note for an order that has been cancelled by the customer in the store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Uuid

String

Unique ID for an order.

x 

Note Payload

Any

Object containing the note.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Receiving Transaction

<newstore:create-receiving-transaction>

Integration APIs > Inventory Management > Inventory Manager API > Create receiving transaction

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

The store identifier.

x 

Create Receiving Transaction Payload

String

Object containing the references(shipment or order reference).

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Return

<newstore:create-return>

Integration APIs > Order Management > Item Return API > Create return Initiates the return process for item(s) in an order.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Id

String

The identifier for the order.

x 

Create Return Payload

Any

Object containing the return.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Transfer Order

<newstore:create-transfer-order>

Integration APIs > Inventory Management > Inventory Manager > Transferring > Create transfer order Creates a transfer order that contains a list of items to be transferred from one store to another. If you use NewStore as inventory master for your business, use this method to create a transfer order to transfer items from a specific stock location to the main or default stock location of another store or DC.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Create Transfer Order Payload

Any

Object containing the due date, the external ref, the from location id, the from stock location, a list of items, the order date, and the to location id.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Create Transfer Transaction

<newstore:create-transfer-transaction>

Integration APIs > Inventory Management > Inventory Manager > Transferring > Create transfer transaction Create and start a transfer transaction.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transfer Order Id

String

The identifier of the open transfer order to create a transaction in.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Delete Fulfillment Location Group

<newstore:delete-fulfillment-location-group>

Order Management > Availabilities Export > Delete fulfillment location group Deletes the specified fulfillment location group.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Group Name

String

The identifier for the fulfillment location group. Use the List fulfillment location groups method to retrieve the ID.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Delete Instore Pickup Config

<newstore:delete-instore-pickup-config>

Integration APIs > Store fulfillment > In-store Pickup API > Delete in-store pickup config Deletes the in-store pickup config set up for your business. When you delete the config, in-store pickup is disabled across all stores.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Delete Instore Pickup Config For Store

<newstore:delete-instore-pickup-config-for-store>

Integration APIs > Store fulfillment > In-store Pickup API > Delete in-store pickup config for store Deletes the in-store pickup config for a store. When you delete the config, in-store pickup is disabled for the store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

The store identifier.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Delete Integration

<newstore:delete-integration>

Event Stream & GraphQL > Event stream configuration API > Integration registration > Delete the integration Deletes an existing integration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Delete Note

<newstore:delete-note>

Integration APIs > Order Management > Order Notes API > Delete note Deletes the note with the specified note ID provided in the request URL.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Uuid

String

Unique ID for an order.

x 

Note Uuid

String

Unique ID for a note.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Delete Rejected Event

<newstore:delete-rejected-event>

Event Stream & GraphQL > Event stream configuration API > Rejected Events > Delete rejected event Deletes the rejected event permanently. NewStore stores 30 rejected events so we recommend that you delete the rejected events that you have handled. To list all the rejected events, use the List rejected events method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Event Id

String

Unique identifier of the event.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Generate Instore Pickup Options

<newstore:generate-instore-pickup-options>

Integration APIs > Store fulfillment > In-store Pickup API > Generate in-store pickup options Generates a list of in-store pickup options for the given geographic location, taking the in-store pickup config into account. The returned options are sorted by proximity to the provided geo-location. Important: The search_radius property is in kilometers. Note: The validity of a shipping offer token can vary based on the shipping provider and shipping offer. For in-store pickup orders, a shipping offer token does not expire.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Generate Pickup Options Payload

Any

An object containing the location, a list of products and the options for the in-store pickup.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get ATP For Channel

<newstore:get-atp-for-channel>

Order Management > Availabilities Export > Get ATP for channel Returns the result of the ATP export job for the provided availability_export_id.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Group Name Or Availability Export Id

String

The identifier for the fulfillment location group for which you want to start an ATP export.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Advance Ship Notice

<newstore:get-advance-ship-notice>

Integration APIs > Inventory Management > Inventory Manager > Receiving > Get ASN Retrieves the ASN for the specified ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Asn Id

String

The unique identifier of the ASN.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Fulfillment Request Item Cancelation Status

<newstore:get-fulfillment-request-item-cancelation-status>

Integration APIs > Order Management > Fulfillment Provider API > Get item cancelation status

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Fulfillment Request Item Rejection Status

<newstore:get-fulfillment-request-item-rejection-status>

Integration APIs > Order Management > Fulfillment Provider API > Get item rejection status

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Fulfillment Request Shipping Status

<newstore:get-fulfillment-request-shipping-status>

Integration APIs > Order Management > Fulfillment Provider API > Get shipping status

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Fulfillment Requests

<newstore:get-fulfillment-requests>

Integration APIs > Order Management > Fulfillment Request API > Get fulfillment requests for an order

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Uuid

String

Sales order UUID.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Import Job

<newstore:get-import-job>

Customer > Catalog and SFCC > Import Data API > Get import job Retrieves the status information of the specified import job.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Import Id

String

Identifier of the job

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Information About Published Events

<newstore:get-information-about-published-events>

Event Stream & GraphQL > Event stream Observability API > Get information about published events. Returns details about an existing integration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

From

String

Only return events which were attempted to be published after this date.

 

To

String

Only return events which were attempted to be published before this date.

 

Integration Id

String

Unique identifier of the integration.

 

Event Name

String

The name of an event stream.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Instore Pickup Config

<newstore:get-instore-pickup-config>

Integration APIs > Store fulfillment > In-store Pickup API > Get in-store pickup config Retrieves the global and store-specific in-store pickup configurations. Important: The default_search_radius property is in kilometers.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Instore Pickup Config For Store

<newstore:get-instore-pickup-config-for-store>

Integration APIs > Store fulfillment > In-store Pickup API > Get in-store pickup config for store Retrieves the store config.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Integration Details

<newstore:get-integration-details>

Event Stream & GraphQL > Event stream configuration API > Integration registration > Get integration details Returns details about an existing integration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Order Notes

<newstore:get-order-notes>

Integration APIs > Order Management > Order Notes API > Get notes by order ID Returns all notes associated with the specified order ID in the request URL sorted from newest to oldest. This method also returns all the notes for the items that are part of the specified order.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Uuid

String

Unique ID for an order.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Rejected Event

<newstore:get-rejected-event>

Event Stream & GraphQL > Event stream configuration API > Rejected Events > Get rejected event Get the payload of the rejected event.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Event Id

String

Unique identifier of the event.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Return

<newstore:get-return>

Integration APIs > Order Management > Item Return API > Get return Retrieves the specified return.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Id

String

The identifier for the order.

x 

Return Id

String

The identifier for the returns.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Transfer Shipping Config

<newstore:get-transfer-shipping-config>

Integration APIs > Inventory Management > Inventory Manager API > Get transfer shipping configuration Retrieves the transfer shipping configuration set up for your business. The response includes the transfer shipping configuration with a list of shipping routes and the service levels configured for each route.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Get Transfer Transaction

<newstore:get-transfer-transaction>

Integration APIs > Inventory Management > Inventory Manager > Transferring > Get transfer transaction Get a transfer transaction.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Transaction Id

String

Transfer Transaction identifier.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Import Stock Quantities

<newstore:import-stock-quantities>

Integration APIs > Inventory Management > Inventory Manager > Counting > Upload stock quantities Imports stock quantities for products in the specified stock location, in the specified store configured for your business. The operation takes a json as input, with the same arguments as a CSV. Important: Use this method to start importing stock quantities only when NewStore is inventory master in the store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Import Stock Payload

Any

Object containing the fulfillment node id, stock location and quantities as an Object.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Import Stock Quantities File

<newstore:import-stock-quantities-file>

Integration APIs > Inventory Management > Inventory Manager > Counting > Upload stock quantities Imports stock quantities for products in the specified stock location, in the specified store configured for your business. The operation takes a file upload which is processed synchronously. Important: Use this method to start importing stock quantities only when NewStore is inventory master in the store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

File Contents

Any

Stock Quantities as an Object.

#[payload]

 

Import Stock Arguments

Any

Object containing the fulfillment node id, and the stock location.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Adjustment Reasons

<newstore:list-adjustment-reasons>

Integration APIs > Inventory Management > Inventory Manager > List adjustment reasons Lists the reasons for inventory adjustments.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Include Inactive

Boolean

Can display all adjustment reasons, including inactive ones.

false

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Count Tasks By Store

<newstore:list-count-tasks-by-store>

Integration APIs > Inventory Management > Inventory Manager API > List count tasks by store Retrieves a list of cycle tasks of a store.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

The store identifier. statuses

x 

Statuses

Array of String

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Fulfillment Location Groups

<newstore:list-fulfillment-location-groups>

Order Management > Availabilities Export > List fulfillment location groups Updates the details of the specified fulfillment location group.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Import Jobs

<newstore:list-import-jobs>

Customer > Catalog and SFCC > Import Data API > List import jobs Returns a list of import jobs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Registered Integrations

<newstore:list-registered-integrations>

Event Stream & GraphQL > Event stream configuration API > Integration registration > List registered integrations Lists all configured integrations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Rejected Events

<newstore:list-rejected-events>

Event Stream & GraphQL > Event stream configuration API > Rejected Events > List rejected events Lists the events that were rejected by the integration (HTTP status code 400). Up to 30 rejected events are stored. To delete some events, use the "Delete rejected event" operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

List Returns

<newstore:list-returns>

Integration APIs > Order Management > Item Return API > List returns for order Retrieves the list of all returns for the order.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Id

String

The identifier for the order.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Register Integration

<newstore:register-integration>

Event Stream & GraphQL > Event stream configuration API > Integration registration > Register new integration Registers a new integration. You can specify how the events will be sent to you: via the webhook. The events are provided in real time. via file upload to the S3 bucket of your choice. An upload typically occurs every 5 minutes.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Register Integration Payload

String

Object containing the integration details.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Reject Fulfillment Request Items

<newstore:reject-fulfillment-request-items>

Integration APIs > Order Management > Fulfillment Provider API > Reject items

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Reject Items Payload

Any

A list of product IDs and the reason why the product couldn’t be fulfilled.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Resend Fulfillment Request

<newstore:resend-fulfillment-request>

Integration APIs > Order Management > Fulfillment Provider API > Resend fulfillment request Resends the specified fulfillment request, regardless of its shipment status (acknowledged, shipped or rejected). Use this method if NewStore was unable to send the fulfillment request. Note: This only applies to orders routed to a DC or warehouse for fulfillment.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Restart The Integration

<newstore:restart-the-integration>

Event Stream & GraphQL > Event stream configuration API > Integration operation > Restart an Integration (Stop + Start operations) Stops and starts the specified integration. NewStore Omnichannel Cloud starts emitting events to the receiving URL. You can check the status of the integration with the Get integration method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Retry Rejected Event

<newstore:retry-rejected-event>

Event Stream & GraphQL > Event stream configuration API > Rejected Events > Retry rejected event Sends the rejected event to the defined endpoint of the integration again. In case the integration responded with a 200 response code, the rejected event will be automatically removed from the rejected event list.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Event Id

String

Unique identifier of the event.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Run Import Job

<newstore:run-import-job>

Customer > Catalog and SFCC > Import Data API > Create import Job + Start Creates an import job to import data into NewStore and adds it to the processing queue. It is automatically processed when it reaches the first position of the queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Run Import Job Payload

Any

Object with the URI to the ZIP file containing the source files in the required NewStore JSON format.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Start ATP Export For Channel

<newstore:start-atp-export-for-channel>

Order Management > Availabilities Export > Start ATP export for channel Starts an export job of the ATP, for a group of fulfillment locations. To retrieve the exported ATP, use the Get ATP for channel method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Group Name Or Availability Export Id

String

The identifier for the fulfillment location group for which you want to start an ATP export.

x 

Start ATP Export For Channel Payload

Any

Object to start a global ATP. When this value is provided the export will not contain availabilities that were updated before the provided value. *

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Start Global ATP Export

<newstore:start-global-atp-export>

Order Management > Availabilities Export > Start Global ATP export Starts an export of the ATP quantities in all fulfillment locations. To retrieve the exported ATP, use the "Get ATP for channel" operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Start Global ATP Payload

Any

Object to start a global ATP. When this value is provided the export will not contain availabilities that were updated before the provided value.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Start The Integration

<newstore:start-the-integration>

Event Stream & GraphQL > Event stream configuration API > Integration operation > Start an integration Starts the specified integration. NewStore Omnichannel Cloud starts emitting events to the receiving URL. You can check the status of the integration with the "Get integration" operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Stop The Integration

<newstore:stop-the-integration>

Event Stream & GraphQL > Event stream configuration API > Integration operation > Stop an integration Stops the specified integration. No events are emitted once the integration is stopped. You can check the status of the integration with the Get integration method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Adjustment Reason

<newstore:update-adjustment-reason>

Integration APIs > Inventory Management > Inventory Manager > Adjusting > Update adjustment reason Use this method to update adjustment reasons in your business. When you create adjustment reasons for your business, they are activated by default. However, if you do not want associates to use a specific adjustment reason to adjust inventory in the store using NewStore Associate App, deactivate it using this method.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Adjustment Reason Id

String

Unique identifier of the adjustment reason

x 

Update Adjustment Reason Payload

Any

Adjustment reason object to update.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Fulfillment Location Group

<newstore:update-fulfillment-location-group>

Order Management > Availabilities Export > Update fulfillment location group Updates the details of the specified fulfillment location group.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Group Name

String

The identifier for the fulfillment location group. Use the List fulfillment location groups method to retrieve the ID.

x 

Update Fulfillment Location Group Payload

Any

List of fulfillment nodes.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Fulfillment Request Item Status

<newstore:update-fulfillment-request-item-status>

Integration APIs > Order Management > Fulfillment Request API > Update the status of order items in a fulfillment request

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Ffr Uuid

String

Fulfillment request UUID.

x 

Update Item Status Payload

Any

Item status list.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Fulfillment Request Shipping Status

<newstore:update-fulfillment-request-shipping-status>

Integration APIs > Order Management > Fulfillment Provider API > Update Shipping Status

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Fulfillment Request Id

String

Unique ID for a fulfillment request.

x 

Update Shipping Status Payload

Any

List of products to update the shipping status.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Instore Pickup Config

<newstore:update-instore-pickup-config>

Integration APIs > Store fulfillment > In-store Pickup API > Update in-store pickup config Updates the global pickup config. Important: The default_search_radius property is in kilometers.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Update Pickup Config Payload

Any

Object containing the display name, the limit of nodes that should be returned, the grace period and the search radius.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Instore Pickup Config For Store

<newstore:update-instore-pickup-config-for-store>

Integration APIs > Store fulfillment > In-store Pickup API > Update in-store pickup config for store Modifies the existing store config or creates a new one if it does not exist.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Store Id

String

The store identifier.

x 

Update Store Pickup Config Payload

Any

Object containing the delivery time, delivery time to when is available and the cost.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Integration

<newstore:update-integration>

Event Stream & GraphQL > Event stream configuration API > Integration registration > Update the integration Updates the specified integration and returns the updated state. Important: Stop the integration before you update it. The typical update workflow is: Stop the integration using the "Stop integration" operation. Poll the "Get integration" operation until status is stopped. Update the integration using the "Update integration" operation. Start the integration using the "Start integration" operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Integration Id

String

Unique identifier of the integration.

x 

Update Integration Payload

Any

Object containing the integration details.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Update Note

<newstore:update-note>

Integration APIs > Order Management > Order Notes API > Update note Updates the note with the specified note ID provided in the request URL.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Order Uuid

String

Unique ID for an order.

x 

Note Uuid

String

Unique ID for a note.

x 

Note Payload

Any

Object containing the note.

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:RETRY_EXHAUSTED  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Route Event Stream

<newstore:route-event-stream>

Event Stream Router based on event type. Called flow must return String (JSON)

Parameters

Name Type Description Default Value Required

Event Routes

Array of Event Route

Array of Event Routes.

x 

Event Payload

Any

Content to be routed. The key "name" must be included to make the routing happen.

#[payload]

 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

  • Number

  • String

  • Boolean

  • Any

  • Array of Any

  • Null

Throws

  • NEWSTORE:CONNECTIVITY  

  • NEWSTORE:INTERNAL  

  • NEWSTORE:INVENTORY  

  • NEWSTORE:LOCATION_NOT_FOUND  

  • NEWSTORE:NOT_FOUND  

  • NEWSTORE:REFERENCE_NOT_UNIQUE  

  • NEWSTORE:UNEXPECTED  

  • NEWSTORE:VALIDATION  

Types

New Store Connection Parameters

Field Type Description Default Value Required

Tenant

String

Typically the name of your company.

x

Stage

String

x

Username

String

x

Password

String

x

Proxy Config

HttpProxyConfig

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #connectionTimeoutUnit.

5

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A #connectionTimeout

SECONDS

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Reason Phrase

String

x

Headers

Object

x

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Event Route

Field Type Description Default Value Required

Event

String

Event name in the payload.

x

Flow

String

Private flow name to be executed.

x