Customers | B2B | Assets

Add assets to customer

Add new customer assets

post/api/BusinessCustomer/{businessCustomerId}/Assets/AddAssets

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/BusinessCustomer/{businessCustomerId}/Assets/AddAssets
  • Auth: API key in header Authorization

Path parameters

businessCustomerIdstring nullable required

Request body

parentIdstring nullable

Optional - ID of parent media or directory

assetIdstring nullable

Optional - ID of asset. If not provided, an id will be generated

assetTypestring nullable

Optional - Type of asset. Free text, except the built-in value "External": an external asset is link-only. It is never copied to Omnium storage, Url mirrors ExternalUrl, and the file is always served live from the external host so a change at the source shows on every product without re-import. Use it for files you do not want Omnium to download, such as certification marks shared by many products. External assets cannot be the main image, so do not point MainImageUrl at one. Changing an already uploaded asset to "External" switches Url to the external url and leaves the old copy in storage.

sortOrderinteger nullable

Optional - Item sort index. Default is position in list

urlstring nullable

Calculated: Omnium url. For "External" assets this is the ExternalUrl itself, since they are not copied to Omnium storage.

externalUrlstring nullable

External URL (original URL, will be uploaded and Omnium url will be added to Url). If FileName is not provided, externalUrl has to contain the file extension (e.g. .jpg). For "External" assets the url is kept as-is and never uploaded; use https, since an http image is blocked as mixed content in browsers.

fileNamestring nullable

Preferred file name, used when uploaded to Omnium. Required to contain the correct file extension. File name and path from external URL will be used as fallback if null.

isMainImageboolean

If true, asset will be used as main image on parent item

namestring nullable

Optional - Asset name

descriptionstring nullable

Optional - Asset description

altTextstring nullable

Optional - Image alternative text

purposestring nullable

Optional - Asset purpose or use

forceUploadboolean nullable

Force upload external url to Omnium (if both external and internal url exists)

fileLoaderTypestring nullable

Calculated - the service that serves the file, for assets that are not reachable through a plain url. Pass it as the serviceType to /api/Files/{serviceType}/Download, together with Url as the path, to download the file. Empty for assets stored in Omnium, which are downloaded from Url directly.

createdstring date-time

Date created

modifiedstring date-time

Date modified

contentTypestring nullable

Calculated - File type, e.g. image/jpg

lengthinteger

Calculated - File size in bytes

Response

Asset added successfully

namestring nullable

Name of company

taxIdstring nullable

Tax ID, or other governmental identification number

creditBalancenumber nullable

(Obsolete) Customer's credit balance. Use BusinessCustomerCredit instead.

creditLimitnumber nullable

(Obsolete) Customer's credit limit. Use BusinessCustomerCredit instead.

creditRemainingnumber nullable

(Obsolete) Customer's remaining credits. Use BusinessCustomerCredit instead.

isCreditDeniedboolean nullable

(Obsolete) Customer's credit is denied if true. Use BusinessCustomerCredit instead.

discountGroupsstring[] nullable

List of customers discount groups

priceGroupsstring[] nullable

List of customers price groups

isAssortmentRestrictedboolean nullable

Set to 'true' if the business customer has a restricted assortment. This is controlled by prices. If the customer has a customer specific price for a product, the product is automatically included in the customer's assortment. If this is set to 'false', a non-customer specific price will be sufficient for the product to be part of the customer's assortment.

punchOutUnitConversionListstring nullable

When using puch-out orders, unit conversion lists can be defined in settings. This reflects the corresponding Unit Conversion List for the customer.

punchOutDomainstring nullable

When using punch-out domain

notificationEmailAddressesstring[] nullable

Emails for notifications (comma separated)

notificationPhoneNumbersstring[] nullable

Phone numbers for notifications (comma separated)

tagsstring[] nullable

Tags for business customer

customerIdstring required

Unique ID

customerNumberstring nullable

Customer identifier - does not have to be unique for each store, etc

phonestring nullable

Customer phone number

emailstring nullable

Customer e-mail

urlstring nullable

Customer url

storeIdsstring[] nullable

Customer favorite stores

marketIdstring nullable

Customer primary market

additionalMarketIdsstring[] nullable

Additional customer markets (beyond the primary MarketId)

marketGroupIdstring nullable

Customer market group

preferredLanguagestring nullable

Preferred customer language code

preferredCurrencystring nullable

Customer preferred currency code (E.g. USD, NOK, EUR)

isGlobalboolean nullable

If true, customer is available in all markets / stores

modifiedBystring nullable

Name of the user or system the last modified the item

createdstring date-time nullable

Date and time the customer was created

modifiedstring date-time nullable

Date and time the customer was modified

isInactiveboolean nullable

True if customer is inactive, and should not be able to make purchases

preferredShippingMethodstring nullable

Customer's preferred shipping method name (default selected in new carts)

paymentTermsstring nullable

Payment terms (free text)

paymentTermsNetinteger nullable

Net payment terms (days)

customerDetailsstring nullable

Customer details (brief summary for customer service representatives)

assortmentIncludeCategoryIdsstring[] nullable

Product category IDs to include in customer's assortment. Only products in these categories will be available to the customer. When posted, if null, the property is not updated. If categories should be removed, send empty list.

assortmentExcludeCategoryIdsstring[] nullable

Product category IDs to exclude from customer's assortment. Products in these categories will not be available to the customer. When posted, if null, the property is not updated. If categories should be removed, send empty list.

Changes

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