Customers | B2C

Patch many private customers in one call. For each patch only properties with a value are updated - the rest are left unchanged. Changed customers are indexed in bulk. Only existing customers are processed - unknown customers are skipped and returned in NotFoundIds. Max size in batch is 100.

patch/api/PrivateCustomers/PatchManyPrivateCustomers

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/PrivateCustomers/PatchManyPrivateCustomers
  • Auth: API key in header Authorization

Query parameters

exportCustomersboolean nullable

If true - Omnium will trigger configured connectors to export updated customers

Request body

firstNamestring nullable

First name

lastNamestring nullable

Last name

genderstring nullable

Gender

birthDatestring date-time nullable

Date of birth

isCustomerClubMemberboolean nullable

True if customer is part of customer club

bonusPointsinteger nullable

Number of bonus points earned by customer

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)

keepExistingCustomPropertiesboolean nullable

Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.

isGlobalboolean nullable

If true, customer is available in all markets / stores

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)

Response

Returns a summary of how many customers were updated, unchanged, and not found.

isModifiedboolean

True if at least one property on the customer was changed by the patch operation.

totalCountinteger

Total number of customers processed by the operation.

updatedCountinteger

Number of customers that were modified and persisted.

unchangedCountinteger

Number of customers that were processed but had no changes to apply.

notFoundCountinteger

Number of customers that could not be found and were therefore skipped.

notFoundIdsstring[] nullable

Ids of customers that could not be found and were therefore skipped. Null for single-customer operations.

errorCountinteger

Number of customers where the update failed due to an error.

errorMessagestring nullable

Concatenated error messages for any customers that failed to update. Each entry includes the customer id and the underlying error.

Changes

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