COMMERCE SERVICES

Shopping Service

Purchase a basket (extended)

Norce Commerce Shopping v1.1 service (1.1)

Entities and methods to handle baskets and payments. The Shopping service is used to create and manage baskets, and prepare them for the checkout process. Commonly the checkout process is handled by the Norce Checkout API, only the legacy checkout process is handled here. For product or pricing data, use the Product service. For order history, use the Order service. To change or manage promotions use the Management API.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Basket

Contains endpoints for manage baskets and their lifecycle, see more information here.

Operations

Checkout

Contains endpoints for initialized the checkout process, read more about it here. There is also the old legacy purchase endpoints, still used by older solutions and Non-PSP purchases.

Operations

Create a payment

Request

Used when adding payments to a PayLater type of transaction.

Query

basketIdinteger(int32)

The internal id of the current basket.

ipAddressstring

The user's ipAddress.

userAgentstring

The user agent of the user's browser.

amountnumber(decimal)

The amount being paid.

paymentMethodinteger(int32)

The payment method used to pay.

pricelistSeedstring

(Optional) A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Bodyapplication/json

(Optional) General: 'parameter'='value' to override payment parameters. See developer documentation tab in admin payment settings for reference of what parameters can be set..

Array [

Namestring or null

The Name of the Entity.

Valuestring or null

The Value of the Entity.

]

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/CreatePayment \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "Name": "string",
      "Value": "string"
    }
  ]'

Responses

Success

Bodyapplication/json

Statusstring or null

String response. OK if successful, otherwise may have different values depending on PSP.

StatusDescriptionstring or null

Descriptive text for the status.

BasketIdinteger or null(int32)

Internal id of the associated basket.

OrderNostring or null

Order number if order's been created.

PaymentCodestring or null

Internal identifier of this specific payment attempt.

PaymentReferencestring or null

External identifier of this specific payment attempt, usually from the PSP.

HostedPaymentPagestring or null

Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer.

RedirectUrlstring or null

Configurated redirection URL after successful payment.

RedirectParametersArray of objects or null(NameValue)

PSP specific data returned for the payment. See PSP documentation.

IsSyncronousboolean or null

Indicates if the payment attempt was synchronous or not.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service used.

Response

application/json

{
  "Status": "string",
  "StatusDescription": "string",
  "BasketId": 0,
  "OrderNo": "string",
  "PaymentCode": "string",
  "PaymentReference": "string",
  "HostedPaymentPage": "string",
  "RedirectUrl": "string",
  "RedirectParameters": [
    { … }
  ],
  "IsSyncronous": true,
  "PaymentServiceId": 0
}

Purchase a basket (extended)

Request

PurchaseEx works as Purchase with the additional parameter paymentParameters. This method should be used when overriding the configured values for selected payment methods. See <a target="_blank" href="https://docs.norce.io/developer-portal/app-development/working-with-the-checkout-process/#purchase-and-payments">Payments</a> for more information about the checkout process.

Query

basketIdinteger(int32)

The internal id of the current basket.

ipAddressstring

The user's ipAddress.

userAgentstring

The user agent of the user's browser.

pricelistSeedstring

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Bodyapplication/json

(Optional) General: 'parameter'='value' to override payment parameters. See developer documentation tab in admin payment settings for reference of what parameters can be set..

Array [

Namestring or null

The Name of the Entity.

Valuestring or null

The Value of the Entity.

]

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/PurchaseEx \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "Name": "string",
      "Value": "string"
    }
  ]'

Responses

Success

Bodyapplication/json

Statusstring or null

String response. OK if successful, otherwise may have different values depending on PSP.

StatusDescriptionstring or null

Descriptive text for the status.

BasketIdinteger or null(int32)

Internal id of the associated basket.

OrderNostring or null

Order number if order's been created.

PaymentCodestring or null

Internal identifier of this specific payment attempt.

PaymentReferencestring or null

External identifier of this specific payment attempt, usually from the PSP.

HostedPaymentPagestring or null

Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer.

RedirectUrlstring or null

Configurated redirection URL after successful payment.

RedirectParametersArray of objects or null(NameValue)

PSP specific data returned for the payment. See PSP documentation.

IsSyncronousboolean or null

Indicates if the payment attempt was synchronous or not.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service used.

Response

application/json

{
  "Status": "string",
  "StatusDescription": "string",
  "BasketId": 0,
  "OrderNo": "string",
  "PaymentCode": "string",
  "PaymentReference": "string",
  "HostedPaymentPage": "string",
  "RedirectUrl": "string",
  "RedirectParameters": [
    { … }
  ],
  "IsSyncronous": true,
  "PaymentServiceId": 0
}

Purchase a basket (extended, v2)

Request

PurchaseEx2 works as Purchase with the additional parameter paymentParameters. This method should be used when overriding the configured values for selected payment methods. See <a target="_blank" href="https://docs.norce.io/developer-portal/app-development/working-with-the-checkout-process/#purchase-and-payments">Payments</a> for more information about the checkout process.

Query

ipAddressstring

The user's ipAddress.

userAgentstring

The user agent of the user's browser.

pricelistSeedstring

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Bodyapplication/json

Extended data object to the PSP for this purchase.

Checkoutobject or null

Used to connect a specific basket with customer information, payment and delivery options.

PaymentParametersArray of objects or null(NameValue)

General: 'test'=true to enable tests. When 'test' is used no payments will be processed for real. Payments may interpret supplied values such as cardNumber or ssn to simulate failures. Not implemented. Klarna: 'sessionId'=id. Used to provide a sessionId to Klarna payments. Not implemented. Payex and Dibs. Supported values are 'returnUrl' and 'cancelUrl'. Values should point to where the payment service should go in case of success/failure.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/PurchaseEx2 \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "Checkout": {
      "Basket": {
        "Id": 0,
        "CustomerId": 0,
        "CompanyId": 0,
        "SalesContactId": 0,
        "StatusId": 0,
        "CurrencyId": 0,
        "CurrencyCode": "str",
        "Comment": "string",
        "OrderReference": "string",
        "DiscountCode": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "ValidTo": "2019-08-24T14:15:22Z",
        "IsEditable": true,
        "Items": [
          {
            "Id": 0,
            "LineNo": 0,
            "ParentLineNo": 0,
            "ProductId": 0,
            "PartNo": "string",
            "ManufacturerPartNo": "string",
            "Name": "string",
            "SubHeader": "string",
            "ThumbnailImage": "string",
            "FlagIdSeed": "string",
            "Type": 0,
            "PriceDisplay": 0,
            "Price": 0,
            "PriceOriginal": 0,
            "Cost": 0,
            "VatRate": 0,
            "Quantity": 0,
            "Uom": "string",
            "UomCount": 0,
            "Comment": "string",
            "PriceListId": 0,
            "ReferId": 0,
            "ReferUrl": "string",
            "IsEditable": true,
            "IsDiscountable": true,
            "Info": [
              {
                "TypeId": 0,
                "Value": "string",
                "Code": "string"
              }
            ],
            "OptionalItems": [
              {}
            ],
            "OnHandValue": 0,
            "IncomingValue": 0,
            "NextDeliveryDate": "2019-08-24T14:15:22Z",
            "LeadtimeDayCount": 0,
            "PromotionIdSeed": "string",
            "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
            "ManufacturerName": "string",
            "CategoryId": 0,
            "OnHand": {
              "Value": 0,
              "IncomingValue": 0,
              "NextDeliveryDate": "2019-08-24T14:15:22Z",
              "LeadtimeDayCount": 0,
              "LastChecked": "2019-08-24T14:15:22Z",
              "IsActive": true,
              "IsReturnable": true,
              "Info": [
                {}
              ]
            },
            "OnHandSupplier": {
              "Value": 0,
              "IncomingValue": 0,
              "NextDeliveryDate": "2019-08-24T14:15:22Z",
              "LeadtimeDayCount": 0,
              "LastChecked": "2019-08-24T14:15:22Z",
              "IsActive": true,
              "IsReturnable": true,
              "Info": [
                {}
              ]
            },
            "PriceRecommended": 0,
            "ManufacturerId": 0,
            "UniqueName": "string",
            "StatusId": 0,
            "StockDisplayBreakPoint": 0,
            "PriceCatalog": 0,
            "IsBuyable": true,
            "SubDescription": "string",
            "CategoryIdSeed": "string",
            "RecommendedQuantity": 0,
            "IsRecommendedQuantityFixed": true,
            "AppliedPromotions": [
              {
                "Id": 0,
                "Name": "string",
                "DiscountCode": "string",
                "AppliedAmount": 0,
                "AppliedAmountIncVat": 0
              }
            ],
            "RequirementPromotionIdSeed": "string",
            "IsSubscribable": true,
            "DescriptionHeader": "string",
            "IsPriceManual": true,
            "PriceStandard": 0,
            "EanCode": "string",
            "CostUnit": 0,
            "PriceDisplayIncVat": 0,
            "PriceListLocked": true,
            "PriceOriginalIncVat": 0,
            "PriceRecommendedIncVat": 0,
            "PriceCatalogIncVat": 0,
            "PriceStandardIncVat": 0,
            "Weight": 0,
            "Height": 0,
            "Width": 0,
            "Length": 0,
            "IsDropShipOnly": true
          }
        ],
        "Info": [
          {
            "TypeId": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "Summary": {
          "Items": {
            "Amount": 0,
            "Vat": 0,
            "AmountIncVat": 0
          },
          "Freigt": {
            "Amount": 0,
            "Vat": 0,
            "AmountIncVat": 0
          },
          "Fees": {
            "Amount": 0,
            "Vat": 0,
            "AmountIncVat": 0
          },
          "Total": {
            "Amount": 0,
            "Vat": 0,
            "AmountIncVat": 0
          }
        },
        "AppliedPromotions": [
          {
            "Id": 0,
            "Name": "string",
            "Header": "string",
            "ShortDescription": "string",
            "Description1": "string",
            "Description2": "string",
            "StartDate": "2019-08-24T14:15:22Z",
            "EndDate": "2019-08-24T14:15:22Z",
            "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
            "RequirementSeed": "string",
            "DiscountCode": "string",
            "IsExcludedFromPriceCalculation": true,
            "AllowProductListing": true,
            "Images": [
              {
                "Id": 0,
                "Type": 0,
                "Name": "string",
                "Description": "string",
                "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd"
              }
            ],
            "ProductFilters": [
              {
                "ManufacturerId": 0,
                "CategorySeed": "string",
                "TypeId": 0,
                "ProductId": 0,
                "VariantProductId": 0,
                "PartNo": "string",
                "PricelistId": 0,
                "FlagId": 0
              }
            ],
            "AppliedAmount": 0,
            "EffectSeed": "string",
            "FreightDiscountPct": 0,
            "IsStackable": true,
            "AppliedAmountIncVat": 0,
            "ExclusivityType": 0,
            "ExternalCode": "string"
          }
        ],
        "IpAddress": "string",
        "AttestedBy": 0,
        "TypeId": 0,
        "DoHold": true,
        "IsBuyable": true,
        "InvoiceReference": "string",
        "PaymentMethodId": 0,
        "DeliveryMethodId": 0,
        "SalesAreaId": 0,
        "ExternalDiscountCode": "string"
      },
      "Buyer": {
        "Id": 0,
        "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
        "Code": "string",
        "Email": "string",
        "Ssn": "string",
        "FirstName": "string",
        "LastName": "string",
        "Phone": "string",
        "CellPhone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "Account": {
          "Id": 0,
          "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
          "LoginName": "string",
          "Name": "string",
          "Roles": [
            0
          ],
          "Authorizations": [
            {
              "Id": 0,
              "Value": "string",
              "Code": "string"
            }
          ],
          "IsActive": true,
          "NewPassword": "string"
        },
        "Companies": [
          {
            "Id": 0,
            "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
            "Code": "string",
            "Name": "string",
            "OrgNo": "string",
            "Phone": "string",
            "ReferId": 0,
            "ReferUrl": "string",
            "DeliveryAddresses": [
              {
                "Id": 0,
                "CareOf": "string",
                "Line1": "string",
                "Line2": "string",
                "Zip": "string",
                "City": "string",
                "CountryId": 0,
                "Country": "string",
                "Region": "string",
                "IsValidated": true,
                "GlobalLocationNo": "string",
                "ShippingPhoneNumber": "string",
                "Code": "string"
              }
            ],
            "InvoiceAddress": {
              "Id": 0,
              "CareOf": "string",
              "Line1": "string",
              "Line2": "string",
              "Zip": "string",
              "City": "string",
              "CountryId": 0,
              "Country": "string",
              "Region": "string",
              "IsValidated": true,
              "GlobalLocationNo": "string",
              "ShippingPhoneNumber": "string",
              "Code": "string"
            },
            "UseInvoiceAddressAsDeliveryAddress": true,
            "Info": [
              {
                "Id": 0,
                "Value": "string",
                "Code": "string"
              }
            ],
            "PricelistIds": [
              0
            ],
            "ParentId": 0,
            "DeliveryMethodIds": [
              0
            ],
            "PaymentMethodIds": [
              0
            ],
            "Email": "string",
            "Flags": [
              {
                "Id": 0,
                "Name": "string",
                "Group": 0,
                "IsSelected": true
              }
            ],
            "VatNo": "string"
          }
        ],
        "DeliveryAddresses": [
          {
            "Id": 0,
            "CareOf": "string",
            "Line1": "string",
            "Line2": "string",
            "Zip": "string",
            "City": "string",
            "CountryId": 0,
            "Country": "string",
            "Region": "string",
            "IsValidated": true,
            "GlobalLocationNo": "string",
            "ShippingPhoneNumber": "string",
            "Code": "string"
          }
        ],
        "InvoiceAddress": {
          "Id": 0,
          "CareOf": "string",
          "Line1": "string",
          "Line2": "string",
          "Zip": "string",
          "City": "string",
          "CountryId": 0,
          "Country": "string",
          "Region": "string",
          "IsValidated": true,
          "GlobalLocationNo": "string",
          "ShippingPhoneNumber": "string",
          "Code": "string"
        },
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "UseInvoiceAddressAsDeliveryAddress": true,
        "Info": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "CrmId": "string",
        "IsActive": true,
        "Created": "2019-08-24T14:15:22Z",
        "Updated": "2019-08-24T14:15:22Z"
      },
      "Payer": {
        "Id": 0,
        "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
        "Code": "string",
        "Email": "string",
        "Ssn": "string",
        "FirstName": "string",
        "LastName": "string",
        "Phone": "string",
        "CellPhone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "Account": {
          "Id": 0,
          "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
          "LoginName": "string",
          "Name": "string",
          "Roles": [
            0
          ],
          "Authorizations": [
            {
              "Id": 0,
              "Value": "string",
              "Code": "string"
            }
          ],
          "IsActive": true,
          "NewPassword": "string"
        },
        "Companies": [
          {
            "Id": 0,
            "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
            "Code": "string",
            "Name": "string",
            "OrgNo": "string",
            "Phone": "string",
            "ReferId": 0,
            "ReferUrl": "string",
            "DeliveryAddresses": [
              {
                "Id": 0,
                "CareOf": "string",
                "Line1": "string",
                "Line2": "string",
                "Zip": "string",
                "City": "string",
                "CountryId": 0,
                "Country": "string",
                "Region": "string",
                "IsValidated": true,
                "GlobalLocationNo": "string",
                "ShippingPhoneNumber": "string",
                "Code": "string"
              }
            ],
            "InvoiceAddress": {
              "Id": 0,
              "CareOf": "string",
              "Line1": "string",
              "Line2": "string",
              "Zip": "string",
              "City": "string",
              "CountryId": 0,
              "Country": "string",
              "Region": "string",
              "IsValidated": true,
              "GlobalLocationNo": "string",
              "ShippingPhoneNumber": "string",
              "Code": "string"
            },
            "UseInvoiceAddressAsDeliveryAddress": true,
            "Info": [
              {
                "Id": 0,
                "Value": "string",
                "Code": "string"
              }
            ],
            "PricelistIds": [
              0
            ],
            "ParentId": 0,
            "DeliveryMethodIds": [
              0
            ],
            "PaymentMethodIds": [
              0
            ],
            "Email": "string",
            "Flags": [
              {
                "Id": 0,
                "Name": "string",
                "Group": 0,
                "IsSelected": true
              }
            ],
            "VatNo": "string"
          }
        ],
        "DeliveryAddresses": [
          {
            "Id": 0,
            "CareOf": "string",
            "Line1": "string",
            "Line2": "string",
            "Zip": "string",
            "City": "string",
            "CountryId": 0,
            "Country": "string",
            "Region": "string",
            "IsValidated": true,
            "GlobalLocationNo": "string",
            "ShippingPhoneNumber": "string",
            "Code": "string"
          }
        ],
        "InvoiceAddress": {
          "Id": 0,
          "CareOf": "string",
          "Line1": "string",
          "Line2": "string",
          "Zip": "string",
          "City": "string",
          "CountryId": 0,
          "Country": "string",
          "Region": "string",
          "IsValidated": true,
          "GlobalLocationNo": "string",
          "ShippingPhoneNumber": "string",
          "Code": "string"
        },
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "UseInvoiceAddressAsDeliveryAddress": true,
        "Info": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "CrmId": "string",
        "IsActive": true,
        "Created": "2019-08-24T14:15:22Z",
        "Updated": "2019-08-24T14:15:22Z"
      },
      "ShipTo": {
        "Id": 0,
        "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
        "Code": "string",
        "Email": "string",
        "Ssn": "string",
        "FirstName": "string",
        "LastName": "string",
        "Phone": "string",
        "CellPhone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "Account": {
          "Id": 0,
          "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
          "LoginName": "string",
          "Name": "string",
          "Roles": [
            0
          ],
          "Authorizations": [
            {
              "Id": 0,
              "Value": "string",
              "Code": "string"
            }
          ],
          "IsActive": true,
          "NewPassword": "string"
        },
        "Companies": [
          {
            "Id": 0,
            "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
            "Code": "string",
            "Name": "string",
            "OrgNo": "string",
            "Phone": "string",
            "ReferId": 0,
            "ReferUrl": "string",
            "DeliveryAddresses": [
              {
                "Id": 0,
                "CareOf": "string",
                "Line1": "string",
                "Line2": "string",
                "Zip": "string",
                "City": "string",
                "CountryId": 0,
                "Country": "string",
                "Region": "string",
                "IsValidated": true,
                "GlobalLocationNo": "string",
                "ShippingPhoneNumber": "string",
                "Code": "string"
              }
            ],
            "InvoiceAddress": {
              "Id": 0,
              "CareOf": "string",
              "Line1": "string",
              "Line2": "string",
              "Zip": "string",
              "City": "string",
              "CountryId": 0,
              "Country": "string",
              "Region": "string",
              "IsValidated": true,
              "GlobalLocationNo": "string",
              "ShippingPhoneNumber": "string",
              "Code": "string"
            },
            "UseInvoiceAddressAsDeliveryAddress": true,
            "Info": [
              {
                "Id": 0,
                "Value": "string",
                "Code": "string"
              }
            ],
            "PricelistIds": [
              0
            ],
            "ParentId": 0,
            "DeliveryMethodIds": [
              0
            ],
            "PaymentMethodIds": [
              0
            ],
            "Email": "string",
            "Flags": [
              {
                "Id": 0,
                "Name": "string",
                "Group": 0,
                "IsSelected": true
              }
            ],
            "VatNo": "string"
          }
        ],
        "DeliveryAddresses": [
          {
            "Id": 0,
            "CareOf": "string",
            "Line1": "string",
            "Line2": "string",
            "Zip": "string",
            "City": "string",
            "CountryId": 0,
            "Country": "string",
            "Region": "string",
            "IsValidated": true,
            "GlobalLocationNo": "string",
            "ShippingPhoneNumber": "string",
            "Code": "string"
          }
        ],
        "InvoiceAddress": {
          "Id": 0,
          "CareOf": "string",
          "Line1": "string",
          "Line2": "string",
          "Zip": "string",
          "City": "string",
          "CountryId": 0,
          "Country": "string",
          "Region": "string",
          "IsValidated": true,
          "GlobalLocationNo": "string",
          "ShippingPhoneNumber": "string",
          "Code": "string"
        },
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "UseInvoiceAddressAsDeliveryAddress": true,
        "Info": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "CrmId": "string",
        "IsActive": true,
        "Created": "2019-08-24T14:15:22Z",
        "Updated": "2019-08-24T14:15:22Z"
      },
      "PaymentMethods": [
        {
          "Id": 0,
          "Name": "string",
          "TypeId": 0,
          "TypeName": "string",
          "Description": "string",
          "PartNo": "string",
          "Price": 0,
          "VatRate": 0,
          "ImagePath": "string",
          "IsSelected": true,
          "Service": {
            "Id": 0,
            "Name": "string",
            "Description": "string",
            "ImagePath": "string",
            "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c"
          },
          "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
          "IsForCompanyOnly": true,
          "IsForPersonOnly": true
        }
      ],
      "DeliveryMethods": [
        {
          "Id": 0,
          "Name": "string",
          "TypeId": 0,
          "TypeName": "string",
          "Description": "string",
          "PartNo": "string",
          "Price": 0,
          "VatRate": 0,
          "IsNotifiable": true,
          "ImagePath": "string",
          "IsSelected": true,
          "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
          "IsForCompanyOnly": true,
          "IsForPersonOnly": true,
          "Cost": 0,
          "StoreId": 0,
          "WarehouseId": 0,
          "LocationId": 0,
          "DropPoints": [
            {
              "Code": "string",
              "RoutingCode": "string",
              "Depot": "string",
              "Name1": "string",
              "Name2": "string",
              "Address1": "string",
              "Address2": "string",
              "PostalCode": "string",
              "City": "string",
              "CountryCode": "string",
              "Contact": "string",
              "Phone": "string",
              "Fax": "string",
              "Email": "string",
              "Latitude": 0.1,
              "Longitude": 0.1,
              "Distance": 0.1,
              "OpeningHours": [
                {}
              ],
              "IsSelected": true
            }
          ],
          "Code": "string",
          "Carrier": "string"
        }
      ],
      "Payments": [
        {
          "PaymentCode": 0,
          "Amount": 0,
          "CardNo": "string",
          "PaymentMethodId": 0,
          "PaymentServiceId": 0
        }
      ]
    },
    "PaymentParameters": [
      {
        "Name": "string",
        "Value": "string"
      }
    ]
  }'

Responses

Success

Bodyapplication/json

Statusstring or null

String response. OK if successful, otherwise may have different values depending on PSP.

StatusDescriptionstring or null

Descriptive text for the status.

BasketIdinteger or null(int32)

Internal id of the associated basket.

OrderNostring or null

Order number if order's been created.

PaymentCodestring or null

Internal identifier of this specific payment attempt.

PaymentReferencestring or null

External identifier of this specific payment attempt, usually from the PSP.

HostedPaymentPagestring or null

Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer.

RedirectUrlstring or null

Configurated redirection URL after successful payment.

RedirectParametersArray of objects or null(NameValue)

PSP specific data returned for the payment. See PSP documentation.

IsSyncronousboolean or null

Indicates if the payment attempt was synchronous or not.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service used.

Response

application/json

{
  "Status": "string",
  "StatusDescription": "string",
  "BasketId": 0,
  "OrderNo": "string",
  "PaymentCode": "string",
  "PaymentReference": "string",
  "HostedPaymentPage": "string",
  "RedirectUrl": "string",
  "RedirectParameters": [
    { … }
  ],
  "IsSyncronous": true,
  "PaymentServiceId": 0
}

DeliveryMethods

Contains endpoints for viewing metadata about configured delivery methods, when using Norces internal shipping logic.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the basket and basketitems.

Operations

OnHand

Contains endpoints for looking up availability on baskets.

Operations

OrderRequest

Contains endpoints for viewing orders snapshots.

Operations

Payments

Contains endpoints for legacy purchases, still used by older solutions and Non-PSP purchases.

Operations

Promotions

Contains endpoints for viewing more promotion information.

Operations

Norce Commerce Shopping v1.1 service (1.1)

Basket

Checkout

Create a payment

Request

Responses

Did the information on the page help you?

Purchase a basket (extended)

Request

Responses

Did the information on the page help you?

Purchase a basket (extended, v2)

Request

Responses

Did the information on the page help you?

DeliveryMethods

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Schemas

Norce Commerce Shopping v1.1 service (1.1)

Basket

Checkout

Create a payment

Request

Responses

Did the information on the page help you?

Purchase a basket (extended)

Request

Responses

Did the information on the page help you?

Purchase a basket (extended, v2)

RequestExpand all

Responses

Did the information on the page help you?

DeliveryMethods

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Schemas

Request