COMMERCE QUERY

Query API 3.0

ApplicationPaymentMethod

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

DeliveryMethodCulture

deliveryMethodIdinteger(int32)

The delivery method identifier.

applicationIdinteger(int32)

The application identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

namestring or null[ 0 .. 50 ] characters

The culture specific name of the delivery method.

descriptionstring or null

The culture specific description of the delivery method.

logoPathstring or null[ 0 .. 255 ] characters

The logo path, not used anymore.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

logoKeystring or null(guid)

The logo key, not commonly used.

clientIdinteger or null(int32)

The client identifier.

applicationDeliveryMethod(ApplicationDeliveryMethod (object or null))

One of:

{
  "deliveryMethodId": 0,
  "applicationId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "logoPath": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "logoKey": "string",
  "clientId": 0,
  "applicationDeliveryMethod": {
    "applicationId": 0,
    "deliveryMethodId": 0,
    "code": "string",
    "onlyCompanies": true,
    "onlyNotCompanies": true,
    "hasLocations": true,
    "hasCustomerFlags": true,
    "hasPaymentMethods": true,
    "hasDeliveryNotification": true,
    "availableAsDropShip": true,
    "allowDangerousGoods": true,
    "currencyId": 0,
    "maxOrderProductValue": 0,
    "maxWeight": 0,
    "maxWidth": 0,
    "maxHeight": 0,
    "maxDepth": 0,
    "maxGirth": 0,
    "maxVolume": 0,
    "maxUnits": 0,
    "minTemp": 0,
    "maxTemp": 0,
    "useVolumeWeight": true,
    "useLargestWeight": true,
    "volumeWeightFactor": 0,
    "isStackable": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "maxVolumeWeight": 0,
    "hasSkuTypes": true,
    "areSkuTypesForced": true,
    "sortOrder": 0,
    "minOrderProductValue": 0,
    "clientId": 0,
    "cultures": [ … ]
  }
}

ApplicationPaymentMethod

applicationIdinteger(int32)

The application identifier.

paymentServiceIdinteger(int32)

The payment service identifier.

paymentMethodIdinteger(int32)

The payment method identifier.

onlyCompaniesboolean

Indicates whether only companies is enabled for the method, no support for B2C.

onlyNotCompaniesboolean

Indicates whether companies are disabled for the method, no support for B2B.

hasDeliveryMethodsboolean

Indicates whether the application payment method has delivery methods as requirement.

hasDivisionsboolean

Indicates whether the application payment method has divisions (stores) as requirement.

hasFieldsboolean

Indicates whether the application payment method has fields restrictions as requirement.

currencyIdinteger or null(int32)

The currency identifier.

minOrderValuenumber or null(decimal)

The min order value.

maxOrderValuenumber or null(decimal)

The max order value.

feenumber(decimal)

The fee.

feeVatRatenumber(decimal)

The fee vat rate.

codestring or null[ 0 .. 50 ] characters

The code of the application payment method.

externalPartnerCodestring or null[ 0 .. 50 ] characters

The external partner code.

partNostring or null[ 0 .. 50 ] characters

The part number.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the application payment method is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

isRecurrableboolean or null

Indicates whether the application payment method can be used for recurring payments.

clientIdinteger or null(int32)

The client identifier.

culturesArray of objects or null(PaymentMethodCulture)

{
  "applicationId": 0,
  "paymentServiceId": 0,
  "paymentMethodId": 0,
  "onlyCompanies": true,
  "onlyNotCompanies": true,
  "hasDeliveryMethods": true,
  "hasDivisions": true,
  "hasFields": true,
  "currencyId": 0,
  "minOrderValue": 0,
  "maxOrderValue": 0,
  "fee": 0,
  "feeVatRate": 0,
  "code": "string",
  "externalPartnerCode": "string",
  "partNo": "string",
  "sortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "isRecurrable": true,
  "clientId": 0,
  "cultures": [
    { … }
  ]
}

PaymentMethodCulture

paymentMethodIdinteger(int32)

The payment method identifier.

applicationIdinteger(int32)

The application identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

namestring or null[ 0 .. 50 ] characters

The culture specific name of the payment method.

descriptionstring or null

The culture specific description of the payment method.

logoPathstring or null[ 0 .. 500 ] characters

The culture specific logo path, not commonly used.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger(int32)

The identifier of the user who last updated the record.

logoKeystring or null(guid)

The culture specific logo key, not commonly used.

clientIdinteger or null(int32)

The client identifier.

applicationPaymentMethod(ApplicationPaymentMethod (object or null))

One of:

{
  "paymentMethodId": 0,
  "applicationId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "logoPath": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "logoKey": "string",
  "clientId": 0,
  "applicationPaymentMethod": {
    "applicationId": 0,
    "paymentServiceId": 0,
    "paymentMethodId": 0,
    "onlyCompanies": true,
    "onlyNotCompanies": true,
    "hasDeliveryMethods": true,
    "hasDivisions": true,
    "hasFields": true,
    "currencyId": 0,
    "minOrderValue": 0,
    "maxOrderValue": 0,
    "fee": 0,
    "feeVatRate": 0,
    "code": "string",
    "externalPartnerCode": "string",
    "partNo": "string",
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "isRecurrable": true,
    "clientId": 0,
    "cultures": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations