Skip to main content
API docs by Redocly

NOM API (0.1)

Download OpenAPI specification:Download

NewStore HQ BFF, mirror service for the NewStore HQ providing HTTP endpoints.

List_coupon_definitions

Retrieves a list of all coupon definitions.

query Parameters
filter
string

The field to filter and its filter value(s). The field is specified in subscript notation and its values are comma separated. To filter by range of values, separate the boundaries by the pipe character (|).

Note: When using the placed_at field, you must use a range notation even when you only need one date. See the example.

Note: You can use this parameter several times in one query to create an AND operation.

offset
integer >= 0
Default: 0

The page offset.

count
integer >= 1
Default: 10

The number of requested documents.

sort
string

Sorts the returned values. Takes 3 values separated by the pipe character (|), the field to sort, the sort order and sort mode for multi-valued fields.

q
string

The term to filter on. A partial match is considered as a match.

Responses

Response samples

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

Create_coupon_definition

Creates a coupon definition from a discount rule. The coupon definition can be used to create a coupon.

Request Body schema: application/json
label
required
string non-empty

Label to identify the coupon definition by. Must be unique, second call with the same label will fail.

pattern
required
string non-empty

RegEx pattern to generate the coupon code with.

validation_rules
Array of strings

A list of validation rules applied by default to the coupons created with this coupon definition.

discount_rule_id
required
string non-empty

Unique identifier of the discount rule applied by default to the coupons.

channel_types
Array of strings <= 5 items
Items Enum: "web" "mobile" "mobile_ios" "mobile_android" "store"
max_redemptions
integer >= 1

TThe maximum number of times a coupon based on this definition can be redeemed.

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "pattern": "string",
  • "validation_rules": [
    ],
  • "discount_rule_id": "string",
  • "channel_types": [
    ],
  • "max_redemptions": 1
}

Response samples

Content type
application/json
{
  • "id": "8E168C319380714DC78D399005105202FC8F",
  • "label": "discount_christmas"
}

Get_coupon_definition

Retrieves the coupon definition with the provided ID.

path Parameters
id
required
string

The ID of a coupon definition.

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "pattern": "string",
  • "validation_rules": [
    ],
  • "discount_rule_id": "string",
  • "channel_types": [
    ],
  • "max_redemptions": 1,
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

List_coupons

not provided

query Parameters
filter
string

The field to filter and its filter value(s). The field is specified in subscript notation and its values are comma separated. To filter by range of values, separate the boundaries by the pipe character (|).

Note: When using the placed_at field, you must use a range notation even when you only need one date. See the example.

Note: You can use this parameter several times in one query to create an AND operation.

offset
integer >= 0
Default: 0

The page offset.

count
integer >= 1
Default: 10

The number of requested documents.

sort
string

Sorts the returned values. Takes 3 values separated by the pipe character (|), the field to sort, the sort order and sort mode for multi-valued fields.

q
string

The term to filter on. A partial match is considered as a match.

Responses

Response samples

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

Create_coupon

Creates a coupon using the given definition.

Request Body schema: application/json
label
string

Optional label to apply to the coupon.

template_label
required
string non-empty

Coupon template label to create coupon by. Multiple coupons can be created using the same label.

validation_rules
Array of strings

OPTIONAL: A list of validation rules to be applied to the coupon. The list provided here is intersected with the one coupon template provides, and validation rules from this list override the ones from coupon template's list on conflict

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "template_label": "string",
  • "validation_rules": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "8E168C319380714DC78D399005105202FC8F",
  • "code": "XMAS2018",
  • "label": "discount_christmas",
  • "is_enabled": true
}

Update_coupon

Updates a coupon.

path Parameters
id
required
string

The ID of a coupon.

Request Body schema: application/json
id
required
string = 36 characters

Unique identifier of the coupon (currently, uuid)

is_enabled
required
boolean

If true, the coupon is enabled (active). If false, the coupon is disabled (inactive)

Responses

Request samples

Content type
application/json
{
  • "id": "stringstringstringstringstringstring",
  • "is_enabled": true
}

Get_coupon

Retrieves the coupon with the provided ID.

path Parameters
id
required
string

The ID of a coupon.

Responses

Response samples

Content type
application/json
{
  • "id": "stringstringstringstringstringstring",
  • "code": "string",
  • "label": "string",
  • "is_enabled": true,
  • "created_at": "2019-08-24T14:15:22Z"
}

Get_payment_history

Returns the payment history of the specified account.

path Parameters
account_id
required
string

The identifier of an account that contains all payments on an order.

The value of this parameter must be the internal ID (UUID) of a sales order.

Responses

Response samples

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

Retry_operation

Retries the financial operation (authorization, capture or refund) identified by the provided correlation identifier. To get an operation's correlation identifier, use the Get payments endpoint.

path Parameters
account_id
required
string

The identifier of an account that contains all payments on an order.

The value of this parameter must be the internal ID (UUID) of a sales order.

Request Body schema: application/json
correlation_id
required
string non-empty

Identifier of the request that should be retried. Only authorizations, captures and refunds are supported.

Responses

Request samples

Content type
application/json
{
  • "correlation_id": "45143100-0922-11e9-b568-0800200c9a66"
}

Response samples

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

List_inventory_transactions

Retrieves a list of all inventory transactions completed using NewStore Fulfillment App, along with the details of the associates who performed these transactions.

Note: The inventory transactions that are still in progress are not returned.

query Parameters
filter
string

The field to filter and its filter value(s). The field is specified in subscript notation and its values are comma separated. To filter by range of values, separate the boundaries by the pipe character (|).

Note: When using the placed_at field, you must use a range notation even when you only need one date. See the example.

Note: You can use this parameter several times in one query to create an AND operation.

offset
integer >= 0
Default: 0

The page offset.

count
integer >= 1
Default: 10

The number of requested documents.

sort
string

Sorts the returned values. Takes 3 values separated by the pipe character (|), the field to sort, the sort order and sort mode for multi-valued fields.

q
string

The term to filter on. A partial match is considered as a match.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get_inventory_transaction

Retrieves the inventory transaction with the specified ID.

path Parameters
uuid
required
string

The internal ID (UUID) of an inventory transaction. To retrieve the UUID, use the List inventory transactions method.

Responses

Response samples

Content type
application/json
{
  • "inventory_transaction_id": "e4dc79a3-a970-47eb-9e78-befaa6afe0cc",
  • "transaction_type": "adjustment",
  • "adjustment_type": "Damage Out",
  • "adjustment_reason": "Broken",
  • "completed_date": "2020-04-14T14:28:54.943613Z",
  • "from_location": "US01",
  • "from_location_label": "New York store",
  • "to_location": "US01",
  • "to_location_label": "Ney York store",
  • "associate_name": "Jane Smith",
  • "associate_email": "jsmith@company.com",
  • "status": "closed",
  • "reference": null,
  • "from_stock_location": "main",
  • "to_stock_location": "damaged",
  • "products": [
    ]
}

List_ASNs

Retrieves a list of all ASNs in the platform, along with the details of the associated inventory operations and associate related to this ASN.

query Parameters
filter
string

The field to filter and its filter value(s). The field is specified in subscript notation and its values are comma separated. To filter by range of values, separate the boundaries by the pipe character (|).

Note: When using the placed_at field, you must use a range notation even when you only need one date. See the example.

Note: You can use this parameter several times in one query to create an AND operation.

offset
integer >= 0
Default: 0

The page offset.

count
integer >= 1
Default: 10

The number of requested documents.

sort
string

Sorts the returned values. Takes 3 values separated by the pipe character (|), the field to sort, the sort order and sort mode for multi-valued fields.

q
string

The term to filter on. A partial match is considered as a match.

Responses

Response samples

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

Get_ASN

Retrieves the ASN with the specified ID.

path Parameters
uuid
required
string

The internal ID of the ASN. To retrieve the UUID, use the List ASNs method.

Responses

Response samples

Content type
application/json
{
  • "products": [
    ],
  • "completed_date": "string",
  • "from_location": "string",
  • "from_location_label": "string",
  • "inventory_asn_id": "string",
  • "references": {
    },
  • "status": "string",
  • "to_location_label": "string",
  • "to_location": "string",
  • "shipment_date": "2019-08-24T14:15:22Z",
  • "product_count_distinct": 0,
  • "product_quantity_sum": 0
}

List_inventory_stock_on_hand

Retrieves a list of all items in your stores, and associated details, including:

query Parameters
filter
string

The field to filter and its filter value(s). The field is specified in subscript notation and its values are comma separated. To filter by range of values, separate the boundaries by the pipe character (|).

Note: When using the placed_at field, you must use a range notation even when you only need one date. See the example.

Note: You can use this parameter several times in one query to create an AND operation.

offset
integer >= 0
Default: 0

The page offset.

count
integer >= 1
Default: 10

The number of requested documents.

sort
string

Sorts the returned values. Takes 3 values separated by the pipe character (|), the field to sort, the sort order and sort mode for multi-valued fields.

q
string

The term to filter on. A partial match is considered as a match.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]