Create Stores

StoreCreateStoresResponse Stores.CreateStores(, )

POST/api/v2/public/stores

Creates or updates stores in bulk. When flush is true, removes existing stores before inserting.

ParametersExpand Collapse

StoreCreateStoresParams parameters

Boolean flush

Query param: When true, removes existing stores before inserting.

IReadOnlyList<Store>? stores

Body param: The list of stores to create or update.

required Boolean IsActive

Whether the store is active.

required Boolean IsActiveDataExchange

Whether data exchange is active for this store.

required Boolean IsWarehouse

Whether the store is a warehouse.

required string StoreName

Display name of the store.

minLength1

required string StoreNumber

Unique store number identifier.

minLength1

string? Address

Street address of the store.

string? AreaDescription

Description of the area.

string? AreaID

Area identifier the store belongs to.

Long? AreaManagerUserID

User identifier of the area manager assigned to the store.

formatint64

string? City

City of the store.

string? ContactDetails

Free-form contact details for the store.

string? CostCenter

Cost center associated with the store.

string? CountryCode

ISO country code.

string? CountryName

Country name.

string? EslServerPath

Path to the ESL server.

IReadOnlyList<FreeField>? FreeFields

Custom free-field key/value pairs.

string? Key

Free-field key.

Int SortOrder

Sort order for display purposes.

formatint32

string? Value

Free-field value.

string? InventLocation

Inventory location associated with the store.

string? IPRangeBegin

Start of the store’s IP range.

string? IPRangeEnd

End of the store’s IP range.

string? LegalEntity

Legal entity associated with the store.

string? LocalServerPath

Path to the local server.

IReadOnlyList<OpeningHour>? OpeningHours

Opening hours for the store, as key/value pairs (e.g. day → 09:00-18:00).

string? Key

Free-field key.

Int SortOrder

Sort order for display purposes.

formatint32

string? Value

Free-field value.

IReadOnlyList<OrderingSchema>? OrderingSchema

Ordering and delivery calendar entries for the store.

required Int Day

Day of the week (1=Monday, 7=Sunday).

formatint32

required Int DeliveryOffset

Delivery offset in days.

formatint32

required DateTimeOffset Time

Time of day for the calendar entry.

formatdate-time

string? CategoryCode

Optional category code this calendar entry applies to.

Int OrderingOffset

Ordering offset in days.

formatint32

string? WeekNumbers

Comma-separated week numbers when this entry applies.

string? PhoneNumber

Contact phone number of the store.

string? PostalCode

Postal code of the store.

Int? PriceLineID

Identifier of the price line applied to the store.

formatint32

string? SecondaryKey

Secondary external key for the store.

string? StoreGln

Global Location Number (GLN) of the store.

DateTimeOffset? StoreNextDeliveryDatetime

Next scheduled delivery datetime for the store.

formatdate-time

DateTimeOffset? StoreNextOrderingDatetime

Next scheduled ordering datetime for the store.

formatdate-time

IReadOnlyList<StorePrinter>? StorePrinters

Printers configured at the store.

required Boolean IsBluetooth

Whether the printer connects via Bluetooth.

string? PrinterIP

IP address of the printer.

string? PrinterName

Display name of the printer.

string? PrinterSerial

Serial number of the printer.

Int PrinterType

Numeric printer type identifier.

formatint32

string? Vendor

Vendor / manufacturer of the printer.

string? StoreStockPool1

Name of stock pool 1.

string? StoreStockPool10

Name of stock pool 10.

string? StoreStockPool2

Name of stock pool 2.

string? StoreStockPool3

Name of stock pool 3.

string? StoreStockPool4

Name of stock pool 4.

string? StoreStockPool5

Name of stock pool 5.

string? StoreStockPool6

Name of stock pool 6.

string? StoreStockPool7

Name of stock pool 7.

string? StoreStockPool8

Name of stock pool 8.

string? StoreStockPool9

Name of stock pool 9.

string? StoreTypeCode

Code identifying the store type.

string? StoreTypeDescription

Description of the store type.

string? TertiaryKey

Tertiary external key for the store.

ReturnsExpand Collapse

class StoreCreateStoresResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create Stores

StoreCreateStoresParams parameters = new();

var response = await client.Stores.CreateStores(parameters);

Console.WriteLine(response);

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}