Stores

Update existing store, replacing all properties

post/api/Stores/Update

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Stores/Update
  • Auth: API key in header Authorization

Request body

idstring required

Store ID (Unique ID)

namestring nullable

Store or warehouse name

storeGroupIdstring nullable

Store group ID

availableOnMarketsstring[] nullable

A list of market ids

phoneNumberstring nullable

Store phone number

emailstring nullable

Store e-mail

commentstring nullable

Comment or description of the store

createdstring date-time

Date store is created (utc)

modifiedstring date-time

Date store is modified (utc)

urlstring nullable

Store URL (URL to home page, web shop, etc)

latitudestring nullable

Location latitude

longitudestring nullable

Location longitude

googlePlaceIdstring nullable

ID of Google Place (optional)

useCustomPickLimitsboolean

Indicates if this store uses custom pick limits instead of global settings

storePickLimitstring

Time limit for store to pick an order

storeExtendedPickLimitstring

Extended time limit for store to pick an order

customerPickupDeadlineLimitstring

Time limit for customer to pick up their order

externalIdsstring[] nullable

Store IDs from external systems

isWarehouseboolean

True if store can have inventory

isPrimaryWarehouseboolean

True if this is a primary company warehouse

isPublicVisibleboolean

True if store information should be visible to end customers

isWebWarehouseboolean

True if warehouse inventory should be available for sale on web

isPrimaryStoreboolean

True if this store is the primary store

isVirtualboolean nullable

Indicates a virtual warehouse. Only to be used with virtual stock locations in Omnium.

hasVirtualStockLocationsboolean nullable

Indicates that the warehouse has virtual warehouses in front. Only viable for physical warehouses. Only to be used with virtual stock locations in Omnium.

bestBetsstring[] nullable

Best bets

shortDescriptionstring nullable

Short store description

descriptionstring nullable

Full store description

imageUrlstring nullable

Url to store image

logoUrlstring nullable

Url to store logo

notificationEmailAddressesstring[] nullable

Email addresses used for notifications(recipient)

notificationPhoneNumbersstring[] nullable

Phone numbers used for notifications(recipient)

documentFooterstring nullable

Footer in documents like order receipt pdf. If store does not have value, fallback to document footer on market

organizationalNumberstring nullable

Organizational number of the store

ibanstring nullable

International bank account number of the store

swiftstring nullable

SWIFT code of the store

bankstring nullable

Bank name of the store

accountingDimensionCodestring nullable

Store dimension/account code emitted on accounting postings (e.g. inter-store cost-transfer lines). Falls back to the store id when not set.

isInactiveboolean nullable

Store is inactive

storeRoleIdsstring[] nullable

Roles the store has

assortmentIncludeCategoryIdsstring[] nullable

CategoryIds included in the store's assortment. This is the categoryId from OmniumProductCategory, and is only a link to an existing ProductCategory in Omnium. When posted, if null, the property is not updated. If categories should be removed, send empty list.

assortmentExcludeCategoryIdsstring[] nullable

CategoryIds excluded from the store's assortment. This is the categoryId from OmniumProductCategory, and is only a link to an existing ProductCategory in Omnium. When posted, if null, the property is not updated. If categories should be removed, send empty list.

defaultOrderTypestring nullable

The default order type that will be used when creating a cart for this store

stockBuffernumber nullable

Stock buffer quantity subtracted from available inventory for this store. Null falls back to the tenant global buffer; 0 explicitly disables fallback. Can be overridden per product via Properties.

Example request

{
  "mondayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "tuesdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "wednesdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "thursdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "fridayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "saturdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "sundayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "additionalOpeningHours": [
    {
      "openingHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      }
    }
  ],
  "storePickLimit": "00:00:00",
  "storeExtendedPickLimit": "00:00:00",
  "customerPickupDeadlineLimit": "00:00:00"
}

Response

Store is updated, and returned

idstring required

Store ID (Unique ID)

namestring nullable

Store or warehouse name

storeGroupIdstring nullable

Store group ID

availableOnMarketsstring[] nullable

A list of market ids

phoneNumberstring nullable

Store phone number

emailstring nullable

Store e-mail

commentstring nullable

Comment or description of the store

createdstring date-time

Date store is created (utc)

modifiedstring date-time

Date store is modified (utc)

urlstring nullable

Store URL (URL to home page, web shop, etc)

latitudestring nullable

Location latitude

longitudestring nullable

Location longitude

googlePlaceIdstring nullable

ID of Google Place (optional)

useCustomPickLimitsboolean

Indicates if this store uses custom pick limits instead of global settings

storePickLimitstring

Time limit for store to pick an order

storeExtendedPickLimitstring

Extended time limit for store to pick an order

customerPickupDeadlineLimitstring

Time limit for customer to pick up their order

externalIdsstring[] nullable

Store IDs from external systems

isWarehouseboolean

True if store can have inventory

isPrimaryWarehouseboolean

True if this is a primary company warehouse

isPublicVisibleboolean

True if store information should be visible to end customers

isWebWarehouseboolean

True if warehouse inventory should be available for sale on web

isPrimaryStoreboolean

True if this store is the primary store

isVirtualboolean nullable

Indicates a virtual warehouse. Only to be used with virtual stock locations in Omnium.

hasVirtualStockLocationsboolean nullable

Indicates that the warehouse has virtual warehouses in front. Only viable for physical warehouses. Only to be used with virtual stock locations in Omnium.

bestBetsstring[] nullable

Best bets

shortDescriptionstring nullable

Short store description

descriptionstring nullable

Full store description

imageUrlstring nullable

Url to store image

logoUrlstring nullable

Url to store logo

notificationEmailAddressesstring[] nullable

Email addresses used for notifications(recipient)

notificationPhoneNumbersstring[] nullable

Phone numbers used for notifications(recipient)

documentFooterstring nullable

Footer in documents like order receipt pdf. If store does not have value, fallback to document footer on market

organizationalNumberstring nullable

Organizational number of the store

ibanstring nullable

International bank account number of the store

swiftstring nullable

SWIFT code of the store

bankstring nullable

Bank name of the store

accountingDimensionCodestring nullable

Store dimension/account code emitted on accounting postings (e.g. inter-store cost-transfer lines). Falls back to the store id when not set.

isInactiveboolean nullable

Store is inactive

storeRoleIdsstring[] nullable

Roles the store has

assortmentIncludeCategoryIdsstring[] nullable

CategoryIds included in the store's assortment. This is the categoryId from OmniumProductCategory, and is only a link to an existing ProductCategory in Omnium. When posted, if null, the property is not updated. If categories should be removed, send empty list.

assortmentExcludeCategoryIdsstring[] nullable

CategoryIds excluded from the store's assortment. This is the categoryId from OmniumProductCategory, and is only a link to an existing ProductCategory in Omnium. When posted, if null, the property is not updated. If categories should be removed, send empty list.

defaultOrderTypestring nullable

The default order type that will be used when creating a cart for this store

stockBuffernumber nullable

Stock buffer quantity subtracted from available inventory for this store. Null falls back to the tenant global buffer; 0 explicitly disables fallback. Can be overridden per product via Properties.

Example response

{
  "mondayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "tuesdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "wednesdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "thursdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "fridayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "saturdayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "sundayOpeningHours": {
    "openFrom": "00:00:00",
    "openTo": "00:00:00"
  },
  "additionalOpeningHours": [
    {
      "openingHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      }
    }
  ],
  "storePickLimit": "00:00:00",
  "storeExtendedPickLimit": "00:00:00",
  "customerPickupDeadlineLimit": "00:00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.