COMMERCE QUERY
/
Query API 3.0
/
Shopping
/
Gets all application delivery methods.

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Schemas

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Gets the payment amount for a specific quotation. Retrieves the amount from a successful StartPaymentProcess transaction, if any.

Request

Path
quotationIdinteger(int32)required

The quotation identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Shopping/GetPaymentAmount(quotationId={quotationId})' \
  -H 'ApplicationId: 0'

Responses

The payment amount as a decimal, or null if no payment transaction was found.

Bodyapplication/json
number or null(decimal)
Response
application/json
0

Gets all application delivery methods.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Shopping/ApplicationDeliveryMethods \
  -H 'ApplicationId: 0'

Responses

A queryable collection of application configured delivery methods.

Bodyapplication/jsonArray [
applicationIdinteger(int32)

The application identifier.

deliveryMethodIdinteger(int32)

The delivery method identifier.

codestring or null[ 0 .. 50 ] characters

The code of the application delivery method.

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.

hasLocationsboolean

Indicates whether the application delivery method has location requirements.

hasCustomerFlagsboolean

Indicates whether the application delivery method has customer flag requirements.

hasPaymentMethodsboolean

Indicates whether the application delivery method has payment method requirements.

hasDeliveryNotificationboolean

Indicates whether the application delivery method has delivery notification. Not commonly used.

availableAsDropShipboolean

Indicates whether available as drop ship is enabled.

allowDangerousGoodsboolean

Indicates whether dangerous goods is allowed.

currencyIdinteger or null(int32)

The currency identifier.

maxOrderProductValuenumber or null(decimal)

The max order product value.

maxWeightnumber or null(decimal)

The max weight.

maxWidthnumber or null(decimal)

The max width.

maxHeightnumber or null(decimal)

The max height.

maxDepthnumber or null(decimal)

The max depth.

maxGirthnumber or null(decimal)

The max girth.

maxVolumenumber or null(decimal)

The max volume.

maxUnitsnumber or null(decimal)

The max units.

minTempnumber or null(decimal)

The min temp.

maxTempnumber or null(decimal)

The max temp.

useVolumeWeightboolean

Indicates whether volume weight is used.

useLargestWeightboolean

Indicates whether largest weight is used.

volumeWeightFactornumber or null(decimal)

The volume weight factor.

isStackableboolean

Indicates whether the application delivery method is stackable.

isActiveboolean

Indicates whether the application delivery 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.

maxVolumeWeightnumber or null(decimal)

The max volume weight.

hasSkuTypesboolean

Indicates whether the application delivery method has sku types as requirements.

areSkuTypesForcedboolean

Indicates whether sku types are forced.

sortOrderinteger or null(int32)

The sort order for display purposes.

minOrderProductValuenumber or null(decimal)

The min order product value.

clientIdinteger or null(int32)

The client identifier.

culturesArray of objects or null(DeliveryMethodCulture)
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Gets all application payment methods.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Shopping/ApplicationPaymentMethods \
  -H 'ApplicationId: 0'

Responses

A queryable collection of application configured payment methods.

Bodyapplication/jsonArray [
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)
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Metadata

Operations