The Customers namespace has Entities and Operations concerned with Customer and Company management.
The Customers namespace has Entities and Operations concerned with Customer and Company management.
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/DeleteCompanyDeliveryMethod?companyId=0&methodId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
The discount to delete. See CompanyDiscount entity for details.
The TypeId defines the rule for how Value is interpreted. 1 = Category discount, 2 = DiscountCode on product. Cannot be changed.
The value to check for on products. If TypeID = 1 then discounts are valid for all products belonging to Category with Category.Code = Value. If TypeId = 2 then the product's discount code is checked. Cannot be changed. MaxLength: 50.
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/DeleteCompanyDiscount?companyId=0' \ -H 'Content-Type: application/json' \ -d '{ "TypeId": 0, "Value": "string", "Discount": 0, "PriceListTypeSeed": "string" }'
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/DeleteCompanyPaymentMethod?companyId=0&methodId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/GetCompany?id=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/GetCompanyByCode?code=string'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/GetCompanyByOrgNo?orgNo=string'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/GetCompanyByOrgNoAndStoreId?orgNo=string&storeId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/GetCompanyPaymentMethod?companyId=0&paymentMethodId=0'
{ "CompanyCode": "string", "PaymentMethodCode": "string", "InvoiceCaptureSettingsCode": "string", "IsActive": true }
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/InactivateCompany?companyId=0&inactivatedBy=0'
The Customer to add to the Company. If the Customer already exists, it will get an Account, if missing, and the Company will be added to the list of Companies for the Customer. Then the Customer will be updated. If the Customer does not exist, it will be created. See UpdateCustomer and CreateCustomer for details. Note that Customer.Companies will be ignored so there's no meaning in passing in Companies there.
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.
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/InsertCompanyCustomer?companyId=0&updatedBy=string' \ -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" }'
Success
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.
[ { "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" } ]
An application generated password used if an Account is created. If none is supplied the password will be generated. Generated passwords are 8 random alpha numeric characters mixed lower and upper case. The password is not stored in clear text in Storm. Only a hash value of the password gets stored.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
The Customer to add to the Company. If the Customer already exists, it will get an Account, if missing, and the Company will be added to the list of Companies for the Customer. Then the Customer will be updated. If the Customer does not exist, it will be created. See UpdateCustomer and CreateCustomer for details. Note that Customer.Companies will be ignored so there's no meaning in passing in Companies there.
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.
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/InsertCompanyCustomer2?companyId=0&updatedBy=string' \ -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" }'
Success
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.
[ { "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" } ]
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/InsertCompanyDeliveryMethod?companyId=0&methodId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/InsertCompanyPaymentMethod?companyId=0&methodId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/InsertCompanyPaymentMethod2?companyId=0&methodId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
{ "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ { … } ], "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": [ { … } ], "PricelistIds": [ 0 ], "ParentId": 0, "DeliveryMethodIds": [ 0 ], "PaymentMethodIds": [ 0 ], "Email": "string", "Flags": [ { … } ], "VatNo": "string" }
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/ListCompaniesByOrgNo?orgNo=string'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
[ { "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "ParentId": 0, "DeliveryMethodIds": [ … ], "PaymentMethodIds": [ … ], "Email": "string", "Flags": [ … ], "VatNo": "string" } ]
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/ListCompaniesByParent?parentId=0'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
[ { "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "ParentId": 0, "DeliveryMethodIds": [ … ], "PaymentMethodIds": [ … ], "Email": "string", "Flags": [ … ], "VatNo": "string" } ]
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/ListCompanyByInfoType?code=string&value=string'
Success
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
[ { "Id": 0, "Key": "string", "Code": "string", "Name": "string", "OrgNo": "string", "Phone": "string", "ReferId": 0, "ReferUrl": "string", "DeliveryAddresses": [ … ], "InvoiceAddress": { … }, "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ … ], "PricelistIds": [ … ], "ParentId": 0, "DeliveryMethodIds": [ … ], "PaymentMethodIds": [ … ], "Email": "string", "Flags": [ … ], "VatNo": "string" } ]
curl -i -X GET \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/ListCompanyDiscounts?companyId=0'
Success
The TypeId defines the rule for how Value is interpreted. 1 = Category discount, 2 = DiscountCode on product. Cannot be changed.
The value to check for on products. If TypeID = 1 then discounts are valid for all products belonging to Category with Category.Code = Value. If TypeId = 2 then the product's discount code is checked. Cannot be changed. MaxLength: 50.
An optional comma-separated list of priceList type-ids for which the discount is valid. MaxLength: 50.
[ { "TypeId": 0, "Value": "string", "Discount": 0, "PriceListTypeSeed": "string" } ]
UpdateCompany updates or creates a Company in Storm for the specified customer. Validation is done before trying to update or create the Company and the below Exceptions might be raised if any important information is missing. Any existing Company will be updated as well. Supply all root data (Code, Name, OrgNo, Phone, ReferUrl, Email, VatNo) about the Company - empty or missing input fields will be emptied. Note though that any missing lists or objects (Addresses, Flags, Info, DeliveryMethodIds, PaymentMethodIds) fields that are not passed in will not be removed but just not updated. PriceLists are not affected here at all.
Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.
The Company to update. If a supplied Company does not have an Id specified it is considered new and will be created as well. Otherwise it will be updated.
The internal Storm Id for the Company. When creating a new Company leave this blank as Storm will generate the Id.
The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50.
A list of delivery Addresses for the Company. 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.
Can be used when updating or inserting addresses on Company. 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 company. Use ApplicationService.ListCompanyInfoTypes for id lookup.
Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company 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.
Points to an optional parent company. Used when companies are connected some how.
Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.
Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.
A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/UpdateCompany?customerId=0&updatedBy=0' \ -H 'Content-Type: application/json' \ -d '{ "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" }'
Success
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.
{ "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": [ … ], "Authorizations": [ … ], "IsActive": true }, "Companies": [ { … } ], "DeliveryAddresses": [ { … } ], "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": [ { … } ], "UseInvoiceAddressAsDeliveryAddress": true, "Info": [ { … } ], "PricelistIds": [ 0 ], "CrmId": "string", "IsActive": true, "Created": "2019-08-24T14:15:22Z", "Updated": "2019-08-24T14:15:22Z" }
A list of discounts to update or insert. See CompanyDiscount entity for details.
The TypeId defines the rule for how Value is interpreted. 1 = Category discount, 2 = DiscountCode on product. Cannot be changed.
The value to check for on products. If TypeID = 1 then discounts are valid for all products belonging to Category with Category.Code = Value. If TypeId = 2 then the product's discount code is checked. Cannot be changed. MaxLength: 50.
An optional comma-separated list of priceList type-ids for which the discount is valid. MaxLength: 50.
curl -i -X POST \ 'https://demo.storm.io/api/1.1/CustomerService.svc/rest/UpsertCompanyDiscounts?companyId=0&updatedBy=string' \ -H 'Content-Type: application/json' \ -d '[ { "TypeId": 0, "Value": "string", "Discount": 0, "PriceListTypeSeed": "string" } ]'