Skip to main content
API docs by Redocly

Configuration API (0.1.0)

Download OpenAPI specification:Download

URL: http://docs.newstore.net/

API for inventory configurations.

Configuration API

API for inventory configurations.

Associate App Configuration

Get Associate App configuration for inventory management features

Returns the current inventory configuration for the Associate App.

query Parameters
store_id
string (Store Id)

Store Identifier for store configuration at store level.

header Parameters
tenant
required
string (Tenant)

Tenant identifier.

Responses

Response samples

Content type
application/json
{
  • "allow_adjustments_manual_quantity_editing": true,
  • "allow_counts_manual_quantity_editing": true,
  • "allow_receiving_manual_quantity_editing": true,
  • "allow_transfers_manual_quantity_editing": true,
  • "enabled": true,
  • "enabled_adjustments_stores": [
    ],
  • "enabled_carton_receiving_stores": [
    ],
  • "enabled_counts_stores": [
    ],
  • "enabled_full_counts_stores": [
    ],
  • "enabled_receiving_stores": [
    ],
  • "enabled_receiving_without_asn_stores": [
    ],
  • "enabled_store_initiated_transfers_stores": [
    ],
  • "enabled_transfers_stores": [
    ],
  • "require_confirmation_on_scanning": true,
  • "store_config": null
}

Set Associate App configuration for inventory management features

Sets the Associate App configuration. Note: you can pass an * to enable store-dependent features.

header Parameters
tenant
required
string (Tenant)

Tenant identifier.

Request Body schema: application/json
allow_adjustments_manual_quantity_editing
required
boolean (Allow Adjustments Manual Quantity Editing)

Allow setting the product quantity when scanning an item on Adjustments

allow_counts_manual_quantity_editing
required
boolean (Allow Counts Manual Quantity Editing)

Allow setting the product quantity when scanning an item on Count Tasks

allow_receiving_manual_quantity_editing
required
boolean (Allow Receiving Manual Quantity Editing)

Allow setting the product quantity when scanning an item on Receiving

allow_transfers_manual_quantity_editing
required
boolean (Allow Transfers Manual Quantity Editing)

Allow setting the product quantity when scanning an item on Transfers

enabled_adjustments_stores
required
Array of strings (Enabled Adjustments Stores)

Stores that can create adjustments

enabled_carton_receiving_stores
required
Array of strings (Enabled Carton Receiving Stores)

Stores which allow receiving using a carton identifier

enabled_counts_stores
required
Array of strings (Enabled Counts Stores)

Stores that can do counts

enabled_full_counts_stores
required
Array of strings (Enabled Full Counts Stores)

Stores that can do full counts

enabled_receiving_stores
required
Array of strings (Enabled Receiving Stores)

Stores that can receive

enabled_receiving_without_asn_stores
required
Array of strings (Enabled Receiving Without Asn Stores)

Stores which can receive without an ASN (blind receiving)

enabled_store_initiated_transfers_stores
required
Array of strings (Enabled Store Initiated Transfers Stores)

Stores where a transfer can be initiated

enabled_transfers_stores
required
Array of strings (Enabled Transfers Stores)

Stores that allow transfers

require_confirmation_on_scanning
required
boolean (Require Confirmation On Scanning)

Require confirmation when scanning an item

Responses

Request samples

Content type
application/json
{
  • "allow_adjustments_manual_quantity_editing": true,
  • "allow_counts_manual_quantity_editing": true,
  • "allow_receiving_manual_quantity_editing": true,
  • "allow_transfers_manual_quantity_editing": true,
  • "enabled_adjustments_stores": [
    ],
  • "enabled_carton_receiving_stores": [
    ],
  • "enabled_counts_stores": [
    ],
  • "enabled_full_counts_stores": [
    ],
  • "enabled_receiving_stores": [
    ],
  • "enabled_receiving_without_asn_stores": [
    ],
  • "enabled_store_initiated_transfers_stores": [
    ],
  • "enabled_transfers_stores": [
    ],
  • "require_confirmation_on_scanning": true
}

Response samples

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

Fulfillment App Configuration

Get Fulfillment App configuration

Returns the current configuration for the Fulfillment App.

header Parameters
tenant
required
string (Tenant)

Tenant identifier.

Responses

Response samples

Content type
application/json
{
  • "adjustment": {
    },
  • "cycle_count": {
    },
  • "receiving": {
    },
  • "transfer": {
    }
}

Update Fulfillment App configuration

Partially updates the Fulfillment App configuration.

header Parameters
tenant
required
string (Tenant)

Tenant identifier.

Request Body schema: application/json
object (Adjustment)
Default: {"enabled":true,"manual_adjustment_enabled":false}

Adjustment configuration.

Attributes

  • enabled Determines whether the Adjustment feature is enabled on the application.
  • manual_adjustment_enabled Determines whether manual adjustment is allowed.
object (Cycle Count)
Default: {"count_modification_enabled":false,"enabled":true,"stock_on_hand_visible":false}

Cycle count configuration.

Attributes

  • enabled Determines whether the Cycle Count feature is enabled on the application.
  • count_modification_enabled Determines whether cycle counts can be modified from the application.
  • stock_on_hand_visible Determines whether current Stock On Hand for an item is visible during cycle counts.
  • additional_identifier_display If set determines which of the external product identifiers to display additionally to product id in count task details.
object (Receiving)
Default: {"blind_receiving_enabled":false,"enabled":true,"manual_receiving_enabled":false,"order_ref":{"enabled":false,"label":"Order Reference"},"shipment_ref":{"enabled":true,"label":"Shipment Reference"}}

Receiving configuration.

Attributes

  • enabled Determines whether the Receiving feature is enabled on the application.
  • blind_receiving_enabled Determines whether blind receiving is allowed.
  • manual_receiving_enabled Determines whether manual receiving is allowed.
  • order_ref Order reference configuration.
  • shipment_ref Shipment reference configuration.
object (Transfer)
Default: {"enabled":true,"manual_adjustment_enabled":false}

Transfers configuration.

Attributes

  • enabled Determines whether the Transfers feature is enabled on the application.
  • manual_adjustment_enabled Determines whether transfer adjustment is allowed.

Responses

Request samples

Content type
application/json
{
  • "adjustment": {
    },
  • "cycle_count": {
    },
  • "receiving": {
    },
  • "transfer": {
    }
}

Response samples

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

Set Fulfillment App configuration

Sets the Fulfillment App configuration in full.

header Parameters
tenant
required
string (Tenant)

Tenant identifier.

Request Body schema: application/json
required
object (RequiredAdjustmentConfig)
required
object (RequiredCycleCountConfig)
required
object (RequiredReceivingConfig)
required
object (RequiredTransferConfig)

Responses

Request samples

Content type
application/json
{
  • "adjustment": {
    },
  • "cycle_count": {
    },
  • "receiving": {
    },
  • "transfer": {
    }
}

Response samples

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