data.json

{
    "Hosts": [
        {
            "Name": "Staging",
            "URL": "https://testservices.hairdirect.com/store"
        },
        {
            "Name": "Production",
            "URL": "https://services.hairdirect.com/store"
        }
    ],
    "Categories": [
        {
            "Name": "Account",
            "Description": "Interact with website account data.",
            "Actions": [
                {
                    "Name": "Update Primary Contact",
                    "Description": "Updates data for the primary contact on the customer's account.",
                    "Endpoint": "/account.svc/account/set/update-default",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceContactId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "PhoneNumber",
                            "Type": "string",
                            "Notes": "Must be 16 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "AddIntegrationQueueRecord",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Set Salesforce Account Id",
                    "Description": "Sets the Salesforce account id for a customer account.",
                    "Endpoint": "/account.svc/account/set/salesforce-account-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceAccountId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "EmailAddress",
                            "Type": "string",
                            "Notes": "Must be 150 characters or less",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Set Customer Email",
                    "Description": " Sets the email address on a customer account",
                    "Endpoint": "/account.svc/account/set/user-email",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceAccountId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "EmailAddress",
                            "Type": "string",
                            "Notes": "Must be 150 characters or less",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Create Website Account For Customer",
                    "Description": "Creates a website account for a customer to log into the website.",
                    "Endpoint": "/account.svc/account/set/create-account",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceAccountId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "EmailAddress",
                            "Type": "string",
                            "Notes": "Must be 150 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "UserName",
                            "Type": "string",
                            "Notes": "Must be 256 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "MobilePhone",
                            "Type": "string",
                            "Notes": "Must be 16 characters or less",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Contact By Salesforce Contact Id",
                    "Description": "Gets a contact with the supplied Salesforce contact id.",
                    "Endpoint": "/account.svc/account/get/by-salesforce-contact-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceContactId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "Contact",
                            "Type": "object",
                            "Notes": ""
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Contact": {
                            "Id": null,
                            "CustomerId": null,
                            "FirstName": null,
                            "LastName": null,
                            "Address": {
                                "AddressId": null,
                                "Street": null,
                                "Street2": null,
                                "City": null,
                                "PostalCode": null,
                                "State": null,
                                "StateCode": null,
                                "Country": null,
                                "CountryCode": null,
                                "CountryId": null,
                                "BackOfficeAddressId": null,
                                "CompanyName": null,
                                "RegionId": null
                            },
                            "Email": null,
                            "Phone": null,
                            "Mobile": null,
                            "Fax": null,
                            "ShopId": null,
                            "IsCustomerDefault": null,
                            "IsBillingDefault": null,
                            "IsShippingDefault": null,
                            "SubscriptionType": null,
                            "subscriptionId": null,
                            "emailId": null,
                            "ContactType": null,
                            "SalesforceContactId": null
                        }
                    }
                },
                {
                    "Name": "Get Customer By Salesforce Account Id",
                    "Description": "Creates a website account for a customer to log into the website.",
                    "Endpoint": "/account.svc/account/get/by-salesforce-account-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceContactId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "Customer",
                            "Type": "object",
                            "Notes": ""
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Customer": {
                            "Id": null,
                            "ShopId": null,
                            "UserId": null,
                            "UserName": null,
                            "Password": null,
                            "SecretQuestion": null,
                            "SecretAnswer": null,
                            "IsActive": null,
                            "DefaultContact": {
                                "Id": null,
                                "CustomerId": null,
                                "FirstName": null,
                                "LastName": null,
                                "Address": {
                                    "AddressId": null,
                                    "Street": null,
                                    "Street2": null,
                                    "City": null,
                                    "PostalCode": null,
                                    "State": null,
                                    "StateCode": null,
                                    "Country": null,
                                    "CountryCode": null,
                                    "CountryId": null,
                                    "BackOfficeAddressId": null,
                                    "CompanyName": null,
                                    "RegionId": null
                                },
                                "Email": null,
                                "Phone": null,
                                "Mobile": null,
                                "Fax": null,
                                "ShopId": null,
                                "IsCustomerDefault": null,
                                "IsBillingDefault": null,
                                "IsShippingDefault": null,
                                "SubscriptionType": null,
                                "subscriptionId": null,
                                "emailId": null,
                                "ContactType": null,
                                "SalesforceContactId": null
                            },
                            "ShippingContact": {
                                "Id": null,
                                "CustomerId": null,
                                "FirstName": null,
                                "LastName": null,
                                "Address": {
                                    "AddressId": null,
                                    "Street": null,
                                    "Street2": null,
                                    "City": null,
                                    "PostalCode": null,
                                    "State": null,
                                    "StateCode": null,
                                    "Country": null,
                                    "CountryCode": null,
                                    "CountryId": null,
                                    "BackOfficeAddressId": null,
                                    "CompanyName": null,
                                    "RegionId": null
                                },
                                "Email": null,
                                "Phone": null,
                                "Mobile": null,
                                "Fax": null,
                                "ShopId": null,
                                "IsCustomerDefault": null,
                                "IsBillingDefault": null,
                                "IsShippingDefault": null,
                                "SubscriptionType": null,
                                "subscriptionId": null,
                                "emailId": null,
                                "ContactType": null,
                                "SalesforceContactId": null
                            },
                            "BillingContact": {
                                "Id": null,
                                "CustomerId": null,
                                "FirstName": null,
                                "LastName": null,
                                "Address": {
                                    "AddressId": null,
                                    "Street": null,
                                    "Street2": null,
                                    "City": null,
                                    "PostalCode": null,
                                    "State": null,
                                    "StateCode": null,
                                    "Country": null,
                                    "CountryCode": null,
                                    "CountryId": null,
                                    "BackOfficeAddressId": null,
                                    "CompanyName": null,
                                    "RegionId": null
                                },
                                "Email": null,
                                "Phone": null,
                                "Mobile": null,
                                "Fax": null,
                                "ShopId": null,
                                "IsCustomerDefault": null,
                                "IsBillingDefault": null,
                                "IsShippingDefault": null,
                                "SubscriptionType": null,
                                "subscriptionId": null,
                                "emailId": null,
                                "ContactType": null,
                                "SalesforceContactId": null
                            },
                            "IsNewsletterSubscribed": null,
                            "BackOfficeCustomerID": null,
                            "BackOfficeCustomerClass": null,
                            "BackOfficeSalesPersonId": null,
                            "TrackingId": null,
                            "SalesforceAccountId": null,
                            "RegistrationId": null
                        }
                    }
                }
            ]
        },
        {
            "Name": "Address",
            "Description": "Interact with customer address data.",
            "Actions": [
                {
                    "Name": "Get Address by Contact Id",
                    "Description": "Gets address data for a supplied contact id.",
                    "Endpoint": "/address.svc/address/get/by-contactid-encrypted",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "Address",
                            "Type": "object",
                            "Notes": ""
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Address": {
                            "ContactIdEncrypted": null,
                            "BackOfficeAddressId": null,
                            "FirstName": null,
                            "LastName": null,
                            "CountryName": null,
                            "CountryCode": null,
                            "StreetAddress1": null,
                            "StreetAddress2": null,
                            "City": null,
                            "StateCode": null,
                            "StateName": null,
                            "PostalCode": null,
                            "Phone": null,
                            "Company": null,
                            "LocationId": null,
                            "IsShippingDefault": null,
                            "IsBillingDefault": null,
                            "SelectedShipping": null,
                            "SelectedBilling": null
                        }
                    }
                },
                {
                    "Name": "Get Customer Addresses",
                    "Description": "Gets all of the addresses for a customer.",
                    "Endpoint": "/address.svc/addresses/get/by-customer-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CustomerIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented value is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SelectedShippingContactIdEncrypted",
                            "Type": "string",
                            "Notes": "Used to indicate that an address is currently designated as the shipping address on an order.",
                            "Required": false
                        },
                        {
                            "Name": "SelectedBillingContactIdEncrypted",
                            "Type": "string",
                            "Notes": "Used to indicate that an address is currently designated as the billing address on an order.",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "CustomerAddresses",
                            "Type": "object array",
                            "Notes": ""
                        }
                    ],
                    "SampleCall": {
                        "CustomerIdEncrypted": "Q4hc46Lf2xJzlzsq+HrtPg==",
                        "CultureCode": "en-US"
                    },
                    "SampleResponse": {
                        "Error": null,
                        "CustomerAddresses": [
                            {
                                "ContactIdEncrypted": null,
                                "BackOfficeAddressId": null,
                                "FirstName": null,
                                "LastName": null,
                                "CountryName": null,
                                "CountryCode": null,
                                "StreetAddress1": null,
                                "StreetAddress2": null,
                                "City": null,
                                "StateCode": null,
                                "StateName": null,
                                "PostalCode": null,
                                "Phone": null,
                                "Company": null,
                                "LocationId": null,
                                "IsShippingDefault": null,
                                "IsBillingDefault": null,
                                "SelectedShipping": null,
                                "SelectedBilling": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Create Address",
                    "Description": "Create an address for a customer.",
                    "Endpoint": "/address.svc/address/set/add",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CustomerIdEncrypted",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Phone",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress1",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress2",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CountryName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StateName",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "City",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PostalCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Company",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsShippingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsBillingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "BackOfficeAddressId",
                            "Type": "string",
                            "Notes": ""
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ContactIdEncrypted": null,
                        "BackOfficeAddressId": null
                    }
                },
                {
                    "Name": "Update Address",
                    "Description": "Updates an address for a customer.",
                    "Endpoint": "/address.svc/address/set/update",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "Optional. Used as the batch id if supplied.",
                            "Required": false
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented value is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Phone",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress1",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress2",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CountryName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StateCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "StateName",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "City",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PostalCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Company",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsShippingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsBillingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "BackOfficeAddressId",
                            "Type": "string",
                            "Notes": ""
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ContactIdEncrypted": null,
                        "BackOfficeAddressId": null
                    }
                },
                {
                    "Name": "Update Contact",
                    "Description": "Updates a contact for a customer.",
                    "Endpoint": "/address.svc/address/set/update-contact",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PhoneNumber",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress1",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress2",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CountryName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StateName",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "City",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PostalCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CompanyName",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsShippingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsBillingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CustomerDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "Email",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "MobilePhone",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "BatchId",
                            "Type": "long",
                            "Notes": "Pass a “-1” if you want to prevent an integration queue record from being created.",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        },
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": ""
                        },
                        {
                            "Name": "Message",
                            "Type": "string",
                            "Notes": ""
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ContactId": null,
                        "Message": null
                    }
                },
                {
                    "Name": "Delete Contact",
                    "Description": "Deletes a contact from a customer account.",
                    "Endpoint": "/address.svc/address/set/delete-contact",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Set Customer Default Shipping Address",
                    "Description": "Sets the default shipping address for a customer account.",
                    "Endpoint": "/address.svc/address/set/default-shipping",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "AddToIntegrationQueue",
                            "Type": "boolean",
                            "Notes": "Defaults to false. Indicates whether a record should be added to the integration queue to sync up with the back office system.",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Set Customer Default Billing Address",
                    "Description": "Sets the default shipping address for a customer account.",
                    "Endpoint": "/address.svc/address/set/default-billing",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "AddToIntegrationQueue",
                            "Type": "boolean",
                            "Notes": "Defaults to false. Indicates whether a record should be added to the integration queue to sync up with the back office system.",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Contact",
                    "Description": "Gets a contact object for the supplied contact Id.",
                    "Endpoint": "/address.svc/address/get/by-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "AddToIntegrationQueue",
                            "Type": "boolean",
                            "Notes": "Irrelevant to this function. Doesn't need to be provided.",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Contact",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Contact": {
                            "Id": null,
                            "CustomerId": null,
                            "FirstName": null,
                            "LastName": null,
                            "Address": {
                                "AddressId": null,
                                "Street": null,
                                "Street2": null,
                                "City": null,
                                "PostalCode": null,
                                "State": null,
                                "StateCode": null,
                                "Country": null,
                                "CountryCode": null,
                                "CountryId": null,
                                "BackOfficeAddressId": null,
                                "CompanyName": null,
                                "RegionId": null
                            },
                            "Email": null,
                            "Phone": null,
                            "Mobile": null,
                            "Fax": null,
                            "ShopId": null,
                            "IsCustomerDefault": null,
                            "IsBillingDefault": null,
                            "IsShippingDefault": null,
                            "SubscriptionType": null,
                            "subscriptionId": null,
                            "emailId": null,
                            "ContactType": null,
                            "SalesforceContactId": null
                        }
                    }
                },
                {
                    "Name": "Create Address From Salesforce",
                    "Description": "Updates data for the primary contact on the customer's account.",
                    "Endpoint": "/address.svc/address/set/add-from-salesforce",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceAccountId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceContactId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "Phone",
                            "Type": "string",
                            "Notes": "Must be 16 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "MobilePhone",
                            "Type": "string",
                            "Notes": "Must be 16 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "EmailAddress",
                            "Type": "string",
                            "Notes": "Must be 150 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress1",
                            "Type": "string",
                            "Notes": "Must be 61 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "StreetAddress2",
                            "Type": "string",
                            "Notes": "Must be 61 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "CountryName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "StateName",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": false
                        },
                        {
                            "Name": "City",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "PostalCode",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": true
                        },
                        {
                            "Name": "Company",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less.",
                            "Required": false
                        },
                        {
                            "Name": "IsShippingDefault",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsBillingDefault",
                            "Type": "boolean",
                            "Notes": "Must be 50 characters or less.",
                            "Required": false
                        },
                        {
                            "Name": "CustomerDefault",
                            "Type": "boolean",
                            "Notes": "Must be 50 characters or less.",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Set Salesforce Contact Id",
                    "Description": "Sets the Salesforce contact id for a contact record",
                    "Endpoint": "/address.svc/contact/set/salesforce-contact-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ContactId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "SalesforceContactId",
                            "Type": "string",
                            "Notes": "Must be 50 characters or less",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                }
            ]
        },
        {
            "Name": "Customer",
            "Description": "Interact with customer data.",
            "Actions": [
                {
                    "Name": "Update Customer From Integration",
                    "Description": "Updates customer information from the back office system.",
                    "Endpoint": "/customer.svc/customer/set/integration-update",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CustomerId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "FirstName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "LastName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "BackOfficeSalespersonId",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "MobilePhone",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Customer For Integration",
                    "Description": "Gets customer data needed for the back office integration.",
                    "Endpoint": "/customer.svc/customer/get/for-integration",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CustomerId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Customer",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Customer": {
                            "SalesforceAccountId": null,
                            "BackOfficeCustomerId": null,
                            "FirstName": null,
                            "LastName": null,
                            "BackOfficeSalespersonId": null,
                            "Username": null,
                            "Email": null,
                            "ShippingContact": {
                                "ContactId": null,
                                "BackOfficeAddressId": null,
                                "SalesforceContactId": null,
                                "FirstName": null,
                                "LastName": null,
                                "CountryName": null,
                                "CountryCode": null,
                                "StreetAddress1": null,
                                "StreetAddress2": null,
                                "City": null,
                                "StateCode": null,
                                "StateName": null,
                                "PostalCode": null,
                                "Phone": null,
                                "Company": null
                            },
                            "BillingContact": {
                                "ContactId": null,
                                "BackOfficeAddressId": null,
                                "SalesforceContactId": null,
                                "FirstName": null,
                                "LastName": null,
                                "CountryName": null,
                                "CountryCode": null,
                                "StreetAddress1": null,
                                "StreetAddress2": null,
                                "City": null,
                                "StateCode": null,
                                "StateName": null,
                                "PostalCode": null,
                                "Phone": null,
                                "Company": null
                            }
                        }
                    }
                }
            ]
        },
        {
            "Name": "Department",
            "Description": "Interact with the storefront department data.",
            "Actions": [
                {
                    "Name": "Get Department Hierarchy",
                    "Description": "Gets the collection of parent & child departments and their corresponding URLs.",
                    "Endpoint": "/department.svc/departments/get/links",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "DepartmentId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "DepartmentLinks",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "DepartmentLinks": [
                            {
                                "ParentName": null,
                                "DepartmentLinkChildren": [
                                    {
                                        "Name": null,
                                        "Url": null,
                                        "NumberOfProducts": null
                                    }
                                ]
                            }
                        ]
                    }
                }
            ]
        },
        {
            "Name": "Email",
            "Description": "Send emails from the website.",
            "Actions": [
                {
                    "Name": "Send SOD Inquiry Email",
                    "Description": "Sends an SOD inquiry email with the details retrieved from the SOD calculator page.",
                    "Endpoint": "/email.svc/email/send/hair-order-inquiry",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "InquiryType",
                            "Type": "string",
                            "Notes": "'SOD' or 'One-Time'",
                            "Required": true
                        },
                        {
                            "Name": "CustomerEmail",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CustomerName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CustomerComments",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CoverAreaLength",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CoverAreaWidth",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CoverAreaUOM",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CoverAreaType",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "HairLength",
                            "Type": "integer",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "HairLengthUOM",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "NumberOfSystems",
                            "Type": "integer",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "NumberOfShipments",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShippingLocation",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CostPerMonth",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "TotalCost",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Successful",
                            "Type": "boolean",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Successful": null
                    }
                },
                {
                    "Name": "Send Order Confirmation Email",
                    "Description": "Sends an order confirmation email from a purchase made on the store.",
                    "Endpoint": "/email.svc/email/send/order-confirmation",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "OrderId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Language",
                            "Type": "string",
                            "Notes": "Currently the only implemented value is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ClientId",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ClientSecret",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "SandBox",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "TriggeredSendName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "DataExtensionDetailName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "StockSystemTriggeredSendName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered."
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                }
            ]
        },
        {
            "Name": "Location",
            "Description": "Interact with location data.",
            "Actions": [
                {
                    "Name": "Get Country List (Name & Code)",
                    "Description": "Gets a list of countries.",
                    "Endpoint": "/location.svc/countries/get/name-and-code",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Countries",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Countries": [
                            {
                                "Id": null,
                                "Name": null,
                                "Code": null,
                                "FirstName": null,
                                "LastName": null,
                                "CountryName": null,
                                "CountryCode": null,
                                "RegionId": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get States For Country",
                    "Description": "Gets the list of states for a supplied country.",
                    "Endpoint": "/location.svc/states/get/by-country-name",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CountryName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented value is: en-US",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Locations",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered."
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Locations": [
                            {
                                "Code": null,
                                "Name": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Warehouse For Region",
                    "Description": "Gets the warehouse for the supplied region.",
                    "Endpoint": "/location.svc/warehouse/get/by-region-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented value is: en-US",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "City",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "StateOrCountry",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered."
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "City": null,
                        "StateOrCountry": null
                    }
                },
                {
                    "Name": "Get Warehouse Id for Back Office Location Code",
                    "Description": "Gets the warehouse id associated with a back office location code.",
                    "Endpoint": "/location.svc/warehouse/get/id-by-location",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "BackOfficeLocationCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "WareHouseId",
                            "Type": "long",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered."
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "WareHouseId": null
                    }
                },
                {
                    "Name": "Get Location Id For Type And Code",
                    "Description": "Gets the location id for a location type and code.",
                    "Endpoint": "/location.svc/location/get/id-by-code-and-type",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "Code",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "LocationTypeId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "LocationId",
                            "Type": "long",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered."
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "LocationId": null
                    }
                },
                {
                    "Name": "Get State Name For Code",
                    "Description": "Gets the name of the state for the supplied code.",
                    "Endpoint": "/location.svc/state/get/name-by-state-code",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "StateCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CountryName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "StateName",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered."
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "StateName": null
                    }
                }
            ]
        },
        {
            "Name": "Manufacturer",
            "Description": "Interact with product manufacturer data.",
            "Actions": [
                {
                    "Name": "Get Manufacturer List",
                    "Description": "Gets a list of manufacturer names, urls, and product counts.",
                    "Endpoint": "/manufacturer.svc/manufacturers/get/links",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "ManufacturerLinks",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ManufacturerLinks": [
                            {
                                "Name": null,
                                "Url": null,
                                "NumberOfProducts": null
                            }
                        ]
                    }
                }
            ]
        },
        {
            "Name": "Order",
            "Description": "Interact with storefront order data.",
            "Actions": [
                {
                    "Name": "Process Order",
                    "Description": "Submits an order placed on the store.",
                    "Endpoint": "/order.svc/order/set/complete",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShippingContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "BillingContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CarrierShippingMethodId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PromotionIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "PromoCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "PayPalPayerId",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "PayPalToken",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CreditCardWalletIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CCOwnerName",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CCNumber",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CardType",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CCExpirationMonth",
                            "Type": "integer",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CCExpirationYear",
                            "Type": "integer",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CCV",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "SpecialInstructions",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "VATId",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "OrderData",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Status",
                            "Type": "integer",
                            "Notes": "0 = Complete | 1 = Failed | 2 = PaymentComplete | 3 = PaymentCompleteWithIssues | 4 = PaymentFailed | 5 = Processing"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "OrderData": {
                            "OrderId": null,
                            "BackOfficeOrderNumber": null,
                            "CurrencyId": null,
                            "RegionTaxRate": null,
                            "OrderTaxRate": null,
                            "ExchangeRate": null,
                            "SpecialInstructions": null,
                            "ShippingContactId": null,
                            "BillingContactId": null,
                            "CarrierID": null,
                            "ShippingCharge": null,
                            "BackOfficeShippingMethod": null,
                            "PromoCode": null,
                            "PromotionSavings": null,
                            "OrderSubtotal": null,
                            "OrderTaxAmount": null,
                            "FreightTaxAmount": null,
                            "OrderGrandTotal": null,
                            "OrderStatusId": null,
                            "OrderItems": [
                                {
                                    "SelectedItemId": null,
                                    "ProductId": null,
                                    "SKU": null,
                                    "Department": null,
                                    "Quantity": null,
                                    "IsVariation": null,
                                    "PromotionId": null,
                                    "UnitPrice": null,
                                    "UnitDiscount": null,
                                    "TaxAmount": null,
                                    "Description": null
                                }
                            ]
                        },
                        "Status": null
                    }
                },
                {
                    "Name": "Delete Order",
                    "Description": "Deletes and order from the store.",
                    "Endpoint": "/order.svc/order/set/delete",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Pending Integration Queue Records",
                    "Description": "Gets all integration queue records with a status of 'pending'.",
                    "Endpoint": "/order.svc/order/get/pending-order-queue-records",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CreatedAfter",
                            "Type": "string",
                            "Notes": "A datetime string.",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Records",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Records": [
                            {
                                "Id": null,
                                "OrderQueueID": null,
                                "BatchId": null,
                                "Type": null,
                                "Params": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Order Details",
                    "Description": "Gets the details of an order.",
                    "Endpoint": "/order.svc/order/get/order-details",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "OrderId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "OrderDetail",
                            "Type": "object",
                            "Notes": "{ 'Customer':{ 'CustomerId': [[Value]], 'SalesforceAccountId': [[Value]] }, 'DefaultBillingContact':{ 'Address':{ 'AddressId': [[Value]], 'BackOfficeAddressId': [[Value]], 'City': [[Value]], 'CompanyName': [[Value]], 'Country': [[Value]], 'CountryCode': [[Value]], 'CountryId': [[Value]], 'PostalCode': [[Value]], 'RegionId': [[Value]], 'State': [[Value]], 'StateCode': [[Value]], 'Street': [[Value]], 'Street2': [[Value]] }, 'ContactType': [[Value]], 'CustomerId': [[Value]], 'Email': [[Value]], 'Fax': [[Value]], 'FirstName': [[Value]], 'Id': [[Value]], 'IsBillingDefault': [[Value]], 'IsCustomerDefault': [[Value]], 'IsShippingDefault': [[Value]], 'LastName': [[Value]], 'Mobile': [[Value]], 'Phone': [[Value]], 'SalesforceContactId': [[Value]], 'ShopId': [[Value]], 'SubscriptionType': [[Value]], 'emailId': [[Value]], 'subscriptionId': [[Value]] }, 'DefaultShippingContact':{ 'Address':{ 'AddressId': [[Value]], 'BackOfficeAddressId': [[Value]], 'City': [[Value]], 'CompanyName': [[Value]], 'Country': [[Value]], 'CountryCode': [[Value]], 'CountryId': [[Value]], 'PostalCode': [[Value]], 'RegionId': [[Value]], 'State': [[Value]], 'StateCode': [[Value]], 'Street': [[Value]], 'Street2': [[Value]] }, 'ContactType': [[Value]], 'CustomerId': [[Value]], 'Email': [[Value]], 'Fax': [[Value]], 'FirstName': [[Value]], 'Id': [[Value]], 'IsBillingDefault': [[Value]], 'IsCustomerDefault': [[Value]], 'IsShippingDefault': [[Value]], 'LastName': [[Value]], 'Mobile': [[Value]], 'Phone': [[Value]], 'SalesforceContactId': [[Value]], 'ShopId': [[Value]], 'SubscriptionType': [[Value]], 'emailId': [[Value]], 'subscriptionId': [[Value]] }, 'DiscountAmount': [[Value]], 'ExtraCharge': [[Value]], 'FreightTaxCharge': [[Value]], 'HandlingCharge': [[Value]], 'LineItems':[ { 'BackOrderQuantity': [[Value]], 'Discount': [[Value]], 'IsRestricted': [[Value]], 'IsVariation': [[Value]], 'ItemId': [[Value]], 'ModelNumber': [[Value]], 'ProductId': [[Value]], 'ProductName': [[Value]], 'ProductUrl': [[Value]], 'Quantity': [[Value]], 'SKU': [[Value]], 'Tax': [[Value]], 'TotalPrice': [[Value]], 'UnitListPrice': [[Value]], 'UnitSalePrice': [[Value]], 'Variations': [[Value]] }, { 'BackOrderQuantity': [[Value]], 'Discount': [[Value]], 'IsRestricted': [[Value]], 'IsVariation': [[Value]], 'ItemId': [[Value]], 'ModelNumber': [[Value]], 'ProductId': [[Value]], 'ProductName': [[Value]], 'ProductUrl': [[Value]], 'Quantity': [[Value]], 'SKU': [[Value]], 'Tax': [[Value]], 'TotalPrice': [[Value]], 'UnitListPrice': [[Value]], 'UnitSalePrice': [[Value]], 'Variations': [[Value]] }, { 'BackOrderQuantity': [[Value]], 'Discount': [[Value]], 'IsRestricted': [[Value]], 'IsVariation': [[Value]], 'ItemId': [[Value]], 'ModelNumber': [[Value]], 'ProductId': [[Value]], 'ProductName': [[Value]], 'ProductUrl': [[Value]], 'Quantity': [[Value]], 'SKU': [[Value]], 'Tax': [[Value]], 'TotalPrice': [[Value]], 'UnitListPrice': [[Value]], 'UnitSalePrice': [[Value]], 'Variations': [[Value]] } ], 'Payment':{ 'AccountName': [[Value]], 'Amount': [[Value]], 'AuthorizationCode': [[Value]], 'AvsResponse': [[Value]], 'CCVResponse': [[Value]], 'CardType': [[Value]], 'Comments': [[Value]], 'CreditCardId': [[Value]], 'CustomerProfileId': [[Value]], 'Declined': [[Value]], 'Expiry': [[Value]], 'Id': [[Value]], 'InWallet': [[Value]], 'Message': [[Value]], 'PaymentProfileId': [[Value]], 'ResponseCode': [[Value]], 'ShippingAmount': [[Value]], 'Status': [[Value]], 'TotalTaxAmount': [[Value]], 'TransactionId': [[Value]], 'Type': [[Value]] }, 'ShippingCharge': [[Value]], 'ShippingMethod': [[Value]], 'Summary':{ 'CustomerId': [[Value]], 'CustomerName': [[Value]], 'ExchangeRate': [[Value]], 'ExternalId': [[Value]], 'Id': [[Value]], 'Notes': [[Value]], 'OrderAmount': [[Value]], 'OrderCurrency': [[Value]], 'OrderDate': [[Value]], 'OrderStatus': [[Value]], 'OrderTotal': [[Value]], 'ParentOrderId': [[Value]], 'PromotionCode': [[Value]], 'PromotionSavings': [[Value]], 'TaxRate': [[Value]], 'VATId': [[Value]] }, 'TaxCharge': [[Value]]}"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "OrderDetail": {
                            "Customer": {
                                "CustomerId": null,
                                "SalesforceAccountId": null

                            },
                            "DefaultBillingContact": {
                                "Address": {
                                    "AddressId": null,
                                    "BackOfficeAddressId": null,
                                    "City": null,
                                    "CompanyName": null,
                                    "Country": null,
                                    "CountryCode": null,
                                    "CountryId": null,
                                    "PostalCode": null,
                                    "RegionId": null,
                                    "State": null,
                                    "StateCode": null,
                                    "Street": null,
                                    "Street2": null
                                },
                                "ContactType": null,
                                "CustomerId": null,
                                "Email": null,
                                "Fax": null,
                                "FirstName": null,
                                "Id": null,
                                "IsBillingDefault": null,
                                "IsCustomerDefault": null,
                                "IsShippingDefault": null,
                                "LastName": null,
                                "Mobile": null,
                                "Phone": null,
                                "SalesforceContactId": null,
                                "ShopId": null,
                                "SubscriptionType": null,
                                "emailId": null,
                                "subscriptionId": null
                            },
                            "DefaultShippingContact": {
                                "Address": {
                                    "AddressId": null,
                                    "BackOfficeAddressId": null,
                                    "City": null,
                                    "CompanyName": null,
                                    "Country": null,
                                    "CountryCode": null,
                                    "CountryId": null,
                                    "PostalCode": null,
                                    "RegionId": null,
                                    "State": null,
                                    "StateCode": null,
                                    "Street": null,
                                    "Street2": null
                                },
                                "ContactType": null,
                                "CustomerId": null,
                                "Email": null,
                                "Fax": null,
                                "FirstName": null,
                                "Id": null,
                                "IsBillingDefault": null,
                                "IsCustomerDefault": null,
                                "IsShippingDefault": null,
                                "LastName": null,
                                "Mobile": null,
                                "Phone": null,
                                "SalesforceContactId": null,
                                "ShopId": null,
                                "SubscriptionType": null,
                                "emailId": null,
                                "subscriptionId": null
                            },
                            "DiscountAmount": null,
                            "ExtraCharge": null,
                            "FreightTaxCharge": null,
                            "HandlingCharge": null,
                            "LineItems": [
                                {
                                    "BackOrderQuantity": null,
                                    "Discount": null,
                                    "IsRestricted": null,
                                    "IsVariation": null,
                                    "ItemId": null,
                                    "ModelNumber": null,
                                    "ProductId": null,
                                    "ProductName": null,
                                    "ProductUrl": null,
                                    "Quantity": null,
                                    "SKU": null,
                                    "Tax": null,
                                    "TotalPrice": null,
                                    "UnitListPrice": null,
                                    "UnitSalePrice": null,
                                    "Variations": null
                                }
                            ],
                            "Payment": {
                                "AccountName": null,
                                "Amount": null,
                                "AuthorizationCode": null,
                                "AvsResponse": null,
                                "CCVResponse": null,
                                "CardType": null,
                                "Comments": null,
                                "CreditCardId": null,
                                "CustomerProfileId": null,
                                "Declined": null,
                                "Expiry": null,
                                "Id": null,
                                "InWallet": null,
                                "Message": null,
                                "PaymentProfileId": null,
                                "ResponseCode": null,
                                "ShippingAmount": null,
                                "Status": null,
                                "TotalTaxAmount": null,
                                "TransactionId": null,
                                "Type": null
                            },
                            "ShippingCharge": null,
                            "ShippingMethod": null,
                            "Summary": {
                                "CustomerId": null,
                                "CustomerName": null,
                                "ExchangeRate": null,
                                "ExternalId": null,
                                "Id": null,
                                "Notes": null,
                                "OrderAmount": null,
                                "OrderCurrency": null,
                                "OrderDate": null,
                                "OrderStatus": null,
                                "OrderTotal": null,
                                "ParentOrderId": null,
                                "PromotionCode": null,
                                "PromotionSavings": null,
                                "TaxRate": null,
                                "VATId": null
                            },
                            "TaxCharge": null
                        }
                    }
                },
                {
                    "Name": "Check Integration Queue Batch For Failures",
                    "Description": "Checks to see if there is a failed integration queue record that is in the same batch as the supplied order queue record.",
                    "Endpoint": "/order.svc/integration-queue/get/check-batch-for-errors",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "BatchId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "OrderQueueId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "failureExists",
                            "Type": "boolean",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "failureExists": null
                    }
                },
                {
                    "Name": "Update Integration Queue Record",
                    "Description": "Updates the status and message on an integration queue record.",
                    "Endpoint": "/order.svc/integration-queue/set/status-and-message",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "OrderQueueId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Status",
                            "Type": "integer",
                            "Notes": "0 = Pending | 1 = Succeeded | 2 = Failed | 3 = Processing",
                            "Required": true
                        },
                        {
                            "Name": "Message",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "OrderQueueId",
                            "Type": "long",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "OrderQueueId": null
                    }
                }
            ]
        },
        {
            "Name": "Payment",
            "Description": "Interact with storefront payment data.",
            "Actions": [
                {
                    "Name": "Get Customer Credit Card Wallet",
                    "Description": "Gets the credit cards stored on a customer's account.",
                    "Endpoint": "/payment.svc/wallet/get/by-customer-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "CustomerIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "SelectedCardIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Wallet",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Wallet": [
                            {
                                "PaymentProfileIdEncrypted": null,
                                "CustomerProfileId": null,
                                "LastFour": null,
                                "NameOnCard": null,
                                "ExpirationMonth": null,
                                "ExpirationYear": null,
                                "CardType": null,
                                "CardNumber": null,
                                "CCV": null,
                                "IsDefault": null,
                                "IsSelected": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Add/Update Wallet Card",
                    "Description": "Updates a card stored in a customer's wallet.",
                    "Endpoint": "/payment.svc/wallet/set/credit-card",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CreditCard",
                            "Type": "object",
                            "Notes": "{ 'PaymentProfileIdEncrypted': [[Value]], 'CustomerProfileId': [[Value]], 'LastFour': [[Value]], 'NameOnCard': [[Value]], 'ExpirationMonth': [[Value]], 'ExpirationYear': [[Value]], 'CardType': [[Value]], 'CardNumber': [[Value]], 'CCV': [[Value]], 'IsDefault': [[Value]], 'IsSelected': [[Value]] }",
                            "Required": true
                        },
                        {
                            "Name": "Address",
                            "Type": "object",
                            "Notes": "{ 'FirstName': [[Value]], 'LastName': [[Value]], 'Country': [[Value]], 'StreetAddress': [[Value]], 'City': [[Value]], 'State': [[Value]], 'PostalCode': [[Value]], 'Phone': [[Value]] }",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "CardIdEncrypted",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "CardIdEncrypted": null
                    }
                },
                {
                    "Name": "Delete Wallet Card",
                    "Description": "Deletes a card stored from customer's wallet.",
                    "Endpoint": "/payment.svc/wallet/delete/credit-card",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "CardIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get PayPal Express Checkout URL",
                    "Description": "Gets a URL to initiate the express checkout process for a customer.",
                    "Endpoint": "/payment.svc/paypal/get/express-checkout-url",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShippingContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PromoCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "ExpressCheckoutUrl",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ExpressCheckoutUrl": null
                    }
                },
                {
                    "Name": "Get PayPal Express Checkout Details",
                    "Description": "Gets the details of the express checkout response.",
                    "Endpoint": "/payment.svc/paypal/get/express-checkout-details",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "Token",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "BatchId",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CustomerIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Credit Card Payment By Id",
                    "Description": "Gets the details of a credit card payment.",
                    "Endpoint": "/payment.svc/credit-card/get/payment-by-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "paymentId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Payment",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Payment": {
                            "Id": null,
                            "AccountNumber": null,
                            "Type": null,
                            "SubType": null,
                            "Amount": null,
                            "TotalTaxAmount": null,
                            "ShippingAmount": null,
                            "Status": null,
                            "Contact": {
                                "Id": null,
                                "CustomerId": null,
                                "FirstName": null,
                                "LastName": null,
                                "Address": {
                                    "AddressId": null,
                                    "Street": null,
                                    "Street2": null,
                                    "City": null,
                                    "PostalCode": null,
                                    "State": null,
                                    "StateCode": null,
                                    "Country": null,
                                    "CountryCode": null,
                                    "CountryId": null,
                                    "BackOfficeAddressId": null,
                                    "CompanyName": null,
                                    "RegionId": null
                                },
                                "Email": null,
                                "Phone": null,
                                "Mobile": null,
                                "Fax": null,
                                "ShopId": null,
                                "IsCustomerDefault": null,
                                "IsBillingDefault": null,
                                "IsShippingDefault": null,
                                "SubscriptionType": null,
                                "subscriptionId": null,
                                "emailId": null,
                                "ContactType": null,
                                "SalesforceContactId": null
                            },
                            "Comments": null,
                            "TransactionId": null,
                            "AuthorizationCode": null,
                            "CreditCardId": null,
                            "ResponseCode": null,
                            "Message": null,
                            "AvsResponse": null,
                            "CCVResponse": null,
                            "InWallet": null,
                            "Declined": null,
                            "CustomerProfileId": null,
                            "PaymentProfileId": null
                        }
                    }
                },
                {
                    "Name": "Get Credit Card Details By Id",
                    "Description": "Gets the details of a credit card used as payment on an order.",
                    "Endpoint": "/payment.svc/credit-card/get/details-by-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CreditCardId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "CreditCard",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "CreditCard": {
                            "CardType": null,
                            "NameOnCard": null,
                            "ExpMonth": null,
                            "ExpYear": null,
                            "LastFour": null,
                            "ContactId": null
                        }
                    }
                }
            ]
        },
        {
            "Name": "Product",
            "Description": "Interact with storefront product data.",
            "Actions": [
                {
                    "Name": "Get Featured Products",
                    "Description": "Gets the current list of featured products.",
                    "Endpoint": "/product.svc/products/get/featured",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "RowsToReturn",
                            "Type": "integer",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionTax",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CountryCode",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Products",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Products": [
                            {
                                "Id": null,
                                "Name": null,
                                "Url": null,
                                "Img": null,
                                "Rating": null,
                                "List": null,
                                "Selling": null,
                                "MnfrName": null,
                                "MnfrUrl": null,
                                "HasVariation": null,
                                "Options": null,
                                "Tag": null,
                                "Orderable": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Related Products",
                    "Description": "Gets related products for a specific product.",
                    "Endpoint": "/product.svc/product/get/related",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionTax",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CountryCode",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Products",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Products": [
                            {
                                "Id": null,
                                "Name": null,
                                "Url": null,
                                "Img": null,
                                "Rating": null,
                                "List": null,
                                "Selling": null,
                                "MnfrName": null,
                                "MnfrUrl": null,
                                "HasVariation": null,
                                "Options": null,
                                "Tag": null,
                                "Orderable": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Alternate Products",
                    "Description": "Gets alternate products for a specific product.",
                    "Endpoint": "/product.svc/product/get/alternate",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionTax",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "CountryCode",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Products",
                            "Type": "object array",
                            "Notes": "[ { 'Id': [[Value]], 'Name': [[Value]], 'Url': [[Value]], 'Img': [[Value]], 'Rating': [[Value]], 'List': [[Value]], 'Selling': [[Value]], 'MnfrName': [[Value]], 'MnfrUrl': [[Value]], 'HasVariation': [[Value]], 'Options': [[Value]], 'Tag': [[Value]], 'Orderable': [[Value]] } ]"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Products": [
                            {
                                "Id": null,
                                "Name": null,
                                "Url": null,
                                "Img": null,
                                "Rating": null,
                                "List": null,
                                "Selling": null,
                                "MnfrName": null,
                                "MnfrUrl": null,
                                "HasVariation": null,
                                "Options": null,
                                "Tag": null,
                                "Orderable": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Product Downloads",
                    "Description": "Gets digital downloads for a specific product.",
                    "Endpoint": "/product.svc/product/get/downloads",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Downloads",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Downloads": [
                            {
                                "Url": null,
                                "Name": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Product Messages",
                    "Description": "Gets custom messaging for a specific product.",
                    "Endpoint": "/product.svc/product/get/messages",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Messages",
                            "Type": "object array",
                            "Notes": "[ { 'Message': [[Value]] } ]"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Messages": [
                            {
                                "Message": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Product Images",
                    "Description": "Gets the images for a specific product.",
                    "Endpoint": "/product.svc/product/get/images",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "VariationId",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Images",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Images": [
                            {
                                "URL": null,
                                "AltText": null,
                                "IsDefault": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Product Videos",
                    "Description": "Gets the videos for a specific product.",
                    "Endpoint": "/product.svc/product/get/videos",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Videos",
                            "Type": "object array",
                            "Notes": "[ { 'Name': [[Value]], 'VideoSourceId': [[Value]], 'IsDefault': [[Value]] } ]"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Videos": [
                            {
                                "Name": null,
                                "VideoSourceId": null,
                                "IsDefault": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Product Specifications",
                    "Description": "Gets the various specifications setup for a specific product.",
                    "Endpoint": "/product.svc/product/get/specs",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Specs",
                            "Type": "object array",
                            "Notes": "[ { 'Name': [[Value]], 'Value': [[Value]] } ]"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Specs": [
                            {
                                "Name": null,
                                "Value": null
                            }
                        ]
                    }
                },
                {
                    "Name": "Get Product Prices",
                    "Description": "Gets the various specifications setup for a specific product.",
                    "Endpoint": "/product.svc/product/get/prices",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Prices",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Prices": {
                            "List": null,
                            "Selling": null,
                            "Promotional": null,
                            "PromotionId": null,
                            "High": null,
                            "Low": null
                        }
                    }
                },
                {
                    "Name": "Get Product Detail Data",
                    "Description": "Gets product details data.",
                    "Endpoint": "/product.svc/product/get/details",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Details",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Details": {
                            "Id": null,
                            "Name": null,
                            "SKU": null,
                            "Active": null,
                            "AllowBackorder": null,
                            "DepartmentId": null,
                            "CollectionId": null,
                            "ManufacturerId": null,
                            "ManufacturerName": null,
                            "URL": null,
                            "RelCanonical": null,
                            "SEOTitle": null,
                            "SEOKeywords": null,
                            "SEODescription": null,
                            "Summary": null,
                            "Description": null,
                            "Directions": null,
                            "Ingredients": null,
                            "HowTo": null
                        }
                    }
                },
                {
                    "Name": "Get Product Inventory",
                    "Description": "Gets inventory data for a product.",
                    "Endpoint": "/product.svc/product/get/inventory",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "AllowBackorder",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "InventoryData",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "InventoryData": {
                            "InventoryStatus": null,
                            "InventoryMessage": null,
                            "Orderable": null,
                            "Quantity": null
                        }
                    }
                },
                {
                    "Name": "Update Product Inventory",
                    "Description": "Updates the quantity of a product.",
                    "Endpoint": "/product.svc/product/set/inventory",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "WarehouseId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Quantity",
                            "Type": "integer",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Product Special Status",
                    "Description": "Gets the product's special status (when applicable). These include hot, sale, and new.",
                    "Endpoint": "/product.svc/product/get/special-status",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "DepartmentId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PromotionalPrice",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "SellingPrice",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "SpecialStatus",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "SpecialStatus": null
                    }
                },
                {
                    "Name": "Update Product Price for Currency",
                    "Description": "Updates the price of a product for a specific currency.",
                    "Endpoint": "/product.svc/product/set/price-for-currency",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "List",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Selling",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Cost",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Add Product Price for Currency",
                    "Description": "Adds a price for product for a specific currency.",
                    "Endpoint": "/product.svc/product/set/add-price-for-currency",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "List",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Selling",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Cost",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Delete Prices for Product",
                    "Description": "Removes all pricing records for a specified product.",
                    "Endpoint": "/product.svc/product/delete/product-prices",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Price for Product and Currency",
                    "Description": "Gets the pricing record for a specified product and currency.",
                    "Endpoint": "/product.svc/product/get/product-prices",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Price",
                            "Type": "object",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Price": {
                            "CurrencyCode": null,
                            "CustomerGroupName": null,
                            "PriceTierName": null,
                            "List": null,
                            "Selling": null,
                            "Bulk": null,
                            "Cost": null,
                            "Recurring": null
                        }
                    }
                },
                {
                    "Name": "Update Product From Integration",
                    "Description": "Updates product data from the back office system.",
                    "Endpoint": "/product.svc/product/set/integration-update",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "SKU",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Weight",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ProductName",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "IsRestricted",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "AllowBackorder",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Create Product From Integration",
                    "Description": "Creates a new product in the store that was created in the back office system.",
                    "Endpoint": "/product.svc/product/set/integration-create",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "SKU",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ModelNumber",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ManufacturerId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Name",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Weight",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Height",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "Length",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "Breadth",
                            "Type": "decimal",
                            "Notes": "",
                            "Required": false
                        },
                        {
                            "Name": "IsRestricted",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "AllowBackorder",
                            "Type": "boolean",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ProductId": null
                    }
                },
                {
                    "Name": "Get Product Id By SKU",
                    "Description": "Gets the product id for the specified SKU.",
                    "Endpoint": "/product.svc/product/get/id-by-sku",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "SKU",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "ProductId",
                            "Type": "long",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "ProductId": null
                    }
                }
            ]
        },
        {
            "Name": "Promotion",
            "Description": "Interact with storefront promotion data.",
            "Actions": [
                {
                    "Name": "Get Free Shipping Amount",
                    "Description": "Gets amount needed for an order to qualify for free shipping.",
                    "Endpoint": "/promotion.svc/promotions/get/free-shipping-amount",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Amount",
                            "Type": "decimal",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Amount": null
                    }
                },
                {
                    "Name": "Get Discount Amount For Promo Code",
                    "Description": "Gets the discount details for a supplied promo code.",
                    "Endpoint": "/promotion.svc/promotions/get/promo-code-discount-for-order",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CustomerIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PromoCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "DiscountAmount",
                            "Type": "decimal",
                            "Notes": ""
                        },
                        {
                            "Name": "PromoCode",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "PromotionIdEncrypted",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "PromoError",
                            "Type": "integer",
                            "Notes": "0 = None | 1 = InvalidCode | 2 = NoUsesLeft | 3 = OrderDoesNotQualify | 4 = DiscountAmountZero"
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "DiscountAmount": null,
                        "PromoCode": null,
                        "PromotionIdEncrypted": null,
                        "PromoError": null
                    }
                }
            ]
        },
        {
            "Name": "Shipping",
            "Description": "Interact with the shipping rates api.",
            "Actions": [
                {
                    "Name": "Get Shipping Options For Address",
                    "Description": "Gets shipping options and rates for the supplied shopping cart and shipping address.",
                    "Endpoint": "/shipping.svc/options/get/by-address",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CountryCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "City",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PostalCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "SelectedCarrierShippingMethodId",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Options",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "WarehouseCity",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "WarehouseStateOrCountry",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "StockDisclaimer",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Options": [
                            {
                                "CarrierShippingMethodId": null,
                                "CarrierId": null,
                                "CarrierName": null,
                                "MethodName": null,
                                "ServiceCode": null,
                                "DeliveryRangeStart": null,
                                "DeliveryRangeEnd": null,
                                "Price": null,
                                "PriceEncrypted": null,
                                "FreeShippingAllowed": null,
                                "IsFree": null
                            }
                        ],
                        "WarehouseCity": null,
                        "WarehouseStateOrCountry": null,
                        "StockDisclaimer": null
                    }
                },
                {
                    "Name": "Get Shipping Options For Contact Id",
                    "Description": "Gets shipping options and rates for the supplied shopping cart and contact id.",
                    "Endpoint": "/shipping.svc/options/get/by-contact-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "SelectedCarrierShippingMethodId",
                            "Type": "long",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Options",
                            "Type": "object array",
                            "Notes": "[ { 'CarrierShippingMethodId': [[Value]], 'CarrierId': [[Value]], 'CarrierName': [[Value]], 'MethodName': [[Value]], 'ServiceCode': [[Value]], 'DeliveryRangeStart': [[Value]], 'DeliveryRangeEnd': [[Value]], 'Price': [[Value]], 'PriceEncrypted': [[Value]], 'FreeShippingAllowed': [[Value]], 'IsFree': [[Value]] } ]"
                        },
                        {
                            "Name": "WarehouseCity",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "WarehouseStateOrCountry",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "StockDisclaimer",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Options": [
                            {
                                "CarrierShippingMethodId": null,
                                "CarrierId": null,
                                "CarrierName": null,
                                "MethodName": null,
                                "ServiceCode": null,
                                "DeliveryRangeStart": null,
                                "DeliveryRangeEnd": null,
                                "Price": null,
                                "PriceEncrypted": null,
                                "FreeShippingAllowed": null,
                                "IsFree": null
                            }
                        ],
                        "WarehouseCity": null,
                        "WarehouseStateOrCountry": null,
                        "StockDisclaimer": null
                    }
                }
            ]
        },
        {
            "Name": "Shopping Cart",
            "Description": "Interact with shopping cart data.",
            "Actions": [
                {
                    "Name": "Get Shopping Cart",
                    "Description": "Gets the cart items in a shopping cart for the supplied shopping cart id.",
                    "Endpoint": "/shoppingcart/get/by-id",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "CartItems",
                            "Type": "object array",
                            "Notes": ""
                        },
                        {
                            "Name": "Subtotal",
                            "Type": "decimal",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "CartItems": [
                            {
                                "SelectedItemIdEncrypted": null,
                                "Quantity": null,
                                "Description": null,
                                "VariationDescription": null,
                                "ImagePath": null,
                                "ImageAlt": null,
                                "UnitPrice": null,
                                "ListPrice": null,
                                "SKU": null,
                                "OnSale": null
                            }
                        ],
                        "Subtotal": null
                    }
                },
                {
                    "Name": "Update Cart Item Quantity",
                    "Description": "Updates the quanity of a single cart item.",
                    "Endpoint": "/shoppingcart/set/cart-item-quantity",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "LineItemIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "Quantity",
                            "Type": "integer",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "RequestedQuantity",
                            "Type": "integer",
                            "Notes": ""
                        },
                        {
                            "Name": "ActualUpdatedQuantity",
                            "Type": "integer",
                            "Notes": ""
                        },
                        {
                            "Name": "Subtotal",
                            "Type": "decimal",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "RequestedQuantity": null,
                        "ActualUpdatedQuantity": null,
                        "Subtotal": null
                    }
                },
                {
                    "Name": "Change Shopping Cart Region",
                    "Description": "Sets the current region on a shopping cart.",
                    "Endpoint": "/shoppingcart/set/region",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShopIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "VATId",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "CurrencyCode",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "CurrencyCode": null
                    }
                },
                {
                    "Name": "Set Shipping Charge on Shopping Cart",
                    "Description": "Sets the shipping charge for a shopping cart.",
                    "Endpoint": "/shoppingcart/set/shipping-charge",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "PriceEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShippingOptionId",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Remove Shipping Charge from Shopping Cart",
                    "Description": "Removes the shipping charge from a shopping cart.",
                    "Endpoint": "/shoppingcart/set/remove-shipping-charge",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Remove Promotional Discount from Shopping Cart",
                    "Description": "Removes the promotion discount from a shopping cart.",
                    "Endpoint": "/shoppingcart/set/remove-promo-discount",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                },
                {
                    "Name": "Get Stock System Disclaimer for Shopping Cart",
                    "Description": "Gets a disclaimer message if a stock system is in the user's shopping cart.",
                    "Endpoint": "/shoppingcart/get/stock-disclaimer",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Message",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Message": null
                    }
                }
            ]
        },
        {
            "Name": "Tax",
            "Description": "Interact with tax data from the storefront.",
            "Actions": [
                {
                    "Name": "Get Tax Rate for Shipping Address",
                    "Description": "Gets the tax rate based on a shipping address' location.",
                    "Endpoint": "/tax/get/by-shipping-address",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ContactIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "VATId",
                            "Type": "string",
                            "Notes": "",
                            "Required": false
                        }
                    ],
                    "Response": [
                        {
                            "Name": "FreightTaxRate",
                            "Type": "decimal",
                            "Notes": ""
                        },
                        {
                            "Name": "OrderTaxRate",
                            "Type": "decimal",
                            "Notes": ""
                        },
                        {
                            "Name": "OrderTaxRateEncrypted",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "FreightTaxRate": null,
                        "OrderTaxRate": null,
                        "OrderTaxRateEncrypted": null
                    }
                },
                {
                    "Name": "Validate VAT Id",
                    "Description": "Validates a VAT Id to ensure it can be used on the order.",
                    "Endpoint": "/tax/get/vat-id-validation",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "CultureCode",
                            "Type": "string",
                            "Notes": "Currently the only implemented option is: en-US",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "VATId",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Success",
                            "Type": "boolean",
                            "Notes": ""
                        },
                        {
                            "Name": "Message",
                            "Type": "string",
                            "Notes": ""
                        },
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null,
                        "Success": null,
                        "Message": null
                    }
                },
                {
                    "Name": "Set Region Tax for Shopping Cart",
                    "Description": "Determines what tax rate a shopping cart is subject to, and sets the rate on the shopping cart record.",
                    "Endpoint": "/tax/set/region-tax",
                    "Verb": "POST",
                    "Payload": [
                        {
                            "Name": "RegionId",
                            "Type": "long",
                            "Notes": "",
                            "Required": true
                        },
                        {
                            "Name": "ShoppingCartIdEncrypted",
                            "Type": "string",
                            "Notes": "",
                            "Required": true
                        }
                    ],
                    "Response": [
                        {
                            "Name": "Error",
                            "Type": "string",
                            "Notes": "Empty string indicates no errors were encountered"
                        }
                    ],
                    "SampleResponse": {
                        "Error": null
                    }
                }
            ]
        }
    ]
}