Entities and methods to handle baskets and payments.
Documentation ShoppingService (1.1)
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/
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.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
- application/json
- application/xml
The actual Customer to use as ShipTo. The Customer can optionally have one Company. If more than one Company is specified, the first will be used. Addresses will be resolve by first looking at the Company and then on the Customer. If no delivery address is specified, the invoice address will be used as delivery address. If more than one delivery address is specified, the first will be used.
The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.
The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.
A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.
A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.
A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.
Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.
Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.
Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateShipTo
- cURL
- JS
- C#
curl -i -X POST \
'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateShipTo?basketId=0&updatedBy=0' \
-H 'Content-Type: application/json' \
-d '{
"Id": 0,
"Key": "string",
"Code": "string",
"Email": "string",
"SSN": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string",
"CellPhone": "string",
"ReferId": 0,
"ReferUrl": "string",
"Account": {
"Id": 0,
"Key": "string",
"LoginName": "string",
"Name": "string",
"Roles": [
0
],
"Authorizations": [
{
"Id": 0,
"Value": "string",
"Code": "string"
}
],
"IsActive": true
},
"Companies": [
{
"Id": 0,
"Key": "string",
"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"
}
],
"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"
},
"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"
}
],
"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"
},
"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"
}'
{ "Basket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ … ], "Info": [ … ], "Summary": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Buyer": { "Id": 0, "Key": "string", "Code": "string", "Email": "string", "SSN": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "Payer": { "Id": 0, "Key": "string", "Code": "string", "Email": "string", "SSN": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "ShipTo": { "Id": 0, "Key": "string", "Code": "string", "Email": "string", "SSN": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "PaymentMethods": [ { … } ], "DeliveryMethods": [ { … } ], "Payments": [ { … } ] }
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.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
- application/json
- application/xml
The actual Customer to use as ShipTo. The Customer can optionally have one Company. If more than one Company is specified, the first will be used. Addresses will be resolve by first looking at the Company and then on the Customer. If no delivery address is specified, the invoice address will be used as delivery address. If more than one delivery address is specified, the first will be used.
The internal Storm Id of the Customer. When creating a new Customer leave this blank as Storm will generate the Id.
The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50.
A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.
A list of delivery Addresses for the Customer. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.
A list of Flags for the Customer. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Customers.
Can be use when updating or inserting addresses on Customer. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.
Contains a list of id-value pairs specific to the client for this customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.
Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.
https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateShipTo2
- cURL
- JS
- C#
curl -i -X POST \
'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/UpdateShipTo2?basketId=0&updatedBy=0' \
-H 'Content-Type: application/json' \
-d '{
"Id": 0,
"Key": "string",
"Code": "string",
"Email": "string",
"SSN": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string",
"CellPhone": "string",
"ReferId": 0,
"ReferUrl": "string",
"Account": {
"Id": 0,
"Key": "string",
"LoginName": "string",
"Name": "string",
"Roles": [
0
],
"Authorizations": [
{
"Id": 0,
"Value": "string",
"Code": "string"
}
],
"IsActive": true
},
"Companies": [
{
"Id": 0,
"Key": "string",
"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"
}
],
"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"
},
"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"
}
],
"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"
},
"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"
}'
{ "Basket": { "Id": 0, "CustomerId": 0, "CompanyId": 0, "SalesContactId": 0, "StatusId": 0, "CurrencyId": 0, "CurrencyCode": "string", "Comment": "string", "OrderReference": "string", "DiscountCode": "string", "ReferId": 0, "ReferUrl": "string", "ValidTo": "2019-08-24T14:15:22Z", "IsEditable": true, "Items": [ … ], "Info": [ … ], "Summary": { … }, "AppliedPromotions": [ … ], "IpAddress": "string", "AttestedBy": 0, "TypeId": 0, "DoHold": true, "IsBuyable": true, "InvoiceReference": "string", "PaymentMethodId": 0, "DeliveryMethodId": 0, "SalesAreaId": 0 }, "Buyer": { "Id": 0, "Key": "string", "Code": "string", "Email": "string", "SSN": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "Payer": { "Id": 0, "Key": "string", "Code": "string", "Email": "string", "SSN": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "ShipTo": { "Id": 0, "Key": "string", "Code": "string", "Email": "string", "SSN": "string", "FirstName": "string", "LastName": "string", "Phone": "string", "CellPhone": "string", "ReferId": 0, "ReferUrl": "string", "Account": { … }, "Companies": [ … ], "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "Flags": [ … ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }, "PaymentMethods": [ { … } ], "DeliveryMethods": [ { … } ], "Payments": [ { … } ] }