Get Associate App configuration for inventory management features Deprecated
Returns the current inventory configuration for the Associate App. This endpoint has been deprecated. Please use the /inventory/config endpoint instead.
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
- 200
- 422
{- "allow_adjustments_manual_quantity_editing": true,
- "allow_counts_manual_quantity_editing": true,
- "allow_full_counts_manual_quantity_editing": true,
- "allow_receiving_manual_quantity_editing": true,
- "allow_transfers_manual_quantity_editing": true,
- "enabled": true,
- "enabled_adjustments_stores": [
- "string"
], - "enabled_carton_receiving_stores": [
- "string"
], - "enabled_counts_stores": [
- "string"
], - "enabled_full_counts_stores": [
- "string"
], - "enabled_receiving_stores": [
- "string"
], - "enabled_receiving_without_asn_stores": [
- "string"
], - "enabled_reservations_stores": [
- "string"
], - "enabled_store_initiated_transfers_stores": [
- "string"
], - "enabled_transfers_stores": [
- "string"
], - "require_confirmation_on_scanning": true,
- "store_config": null
}
Set Associate App configuration for inventory management features Deprecated
Sets the Associate App configuration. Note: you can pass an * to enable store-dependent features. This endpoint has been deprecated. Please use the /inventory/config endpoint instead.
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_full_counts_manual_quantity_editing required | boolean (Allow Full Counts Manual Quantity Editing) Allow setting the product quantity when scanning items on Full counts |
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_reservations_stores required | Array of strings (Enabled Reservations Stores) Stores that can do customer reservations |
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
- Payload
{- "allow_adjustments_manual_quantity_editing": true,
- "allow_counts_manual_quantity_editing": true,
- "allow_full_counts_manual_quantity_editing": true,
- "allow_receiving_manual_quantity_editing": true,
- "allow_transfers_manual_quantity_editing": true,
- "enabled_adjustments_stores": [
- "string"
], - "enabled_carton_receiving_stores": [
- "string"
], - "enabled_counts_stores": [
- "string"
], - "enabled_full_counts_stores": [
- "string"
], - "enabled_receiving_stores": [
- "string"
], - "enabled_receiving_without_asn_stores": [
- "string"
], - "enabled_reservations_stores": [
- "string"
], - "enabled_store_initiated_transfers_stores": [
- "string"
], - "enabled_transfers_stores": [
- "string"
], - "require_confirmation_on_scanning": true
}
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Get Fulfillment App configuration Deprecated
Returns the current configuration for the Fulfillment App. This endpoint has been deprecated since the Fulfillment App has reached end of life (EOL). The corresponding config for the Associate App can be found in the /inventory/config endpoint.
header Parameters
tenant required | string (Tenant) Tenant identifier. |
Responses
Response samples
- 200
- 422
{- "adjustment": {
- "enabled": true,
- "manual_adjustment_enabled": false
}, - "cycle_count": {
- "count_modification_enabled": false,
- "enabled": true,
- "stock_on_hand_visible": false
}, - "receiving": {
- "blind_receiving_enabled": false,
- "enabled": true,
- "manual_receiving_enabled": false,
- "order_ref": {
- "enabled": false,
- "label": "Order Reference"
}, - "shipment_ref": {
- "enabled": true,
- "label": "Shipment Reference"
}
}, - "transfer": {
- "enabled": true,
- "manual_adjustment_enabled": false
}
}
Update Fulfillment App configuration Deprecated
Partially updates the Fulfillment App configuration. This endpoint has been deprecated since the Fulfillment App has reached end of life (EOL). The corresponding config for the Associate App can be found in the /inventory/config endpoint.
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
| |
object (Cycle Count) Default: {"count_modification_enabled":false,"enabled":true,"stock_on_hand_visible":false} Cycle count configuration. Attributes
| |
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
| |
object (Transfer) Default: {"enabled":true,"manual_adjustment_enabled":false} Transfers configuration. Attributes
|
Responses
Request samples
- Payload
{- "adjustment": {
- "enabled": true,
- "manual_adjustment_enabled": false
}, - "cycle_count": {
- "count_modification_enabled": false,
- "enabled": true,
- "stock_on_hand_visible": false
}, - "receiving": {
- "blind_receiving_enabled": false,
- "enabled": true,
- "manual_receiving_enabled": false,
- "order_ref": {
- "enabled": false,
- "label": "Order Reference"
}, - "shipment_ref": {
- "enabled": true,
- "label": "Shipment Reference"
}
}, - "transfer": {
- "enabled": true,
- "manual_adjustment_enabled": false
}
}
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
Set Fulfillment App configuration Deprecated
Sets the Fulfillment App configuration in full. This endpoint has been deprecated since the Fulfillment App has reached end of life (EOL). The corresponding config for the Associate App can be found in the /inventory/config endpoint.
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
- Payload
{- "adjustment": {
- "enabled": true,
- "manual_adjustment_enabled": true
}, - "cycle_count": {
- "additional_identifier_display": "string",
- "count_modification_enabled": true,
- "enabled": true,
- "stock_on_hand_visible": true
}, - "receiving": {
- "blind_receiving_enabled": true,
- "enabled": true,
- "manual_receiving_enabled": true,
- "order_ref": {
- "enabled": true,
- "label": "string"
}, - "shipment_ref": {
- "enabled": true,
- "label": "string"
}
}, - "transfer": {
- "enabled": true,
- "manual_adjustment_enabled": true
}
}
Response samples
- 422
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}