Request access for your application by signing up at the developer portal. You will need to sign up separately for each environment below.
\nDevelopment Environment: https://ntsdev.developer.azure-api.net
\nProduction Environment: https://nts.developer.azure-api.net
\nOnce you sign up you will receive an email that has a verification link in it. Click through that email link to verify your email address
\nAfter you have verified your email address and upon final review by the Web.com International team your account will be granted access to our API. Once we have granted access you will receive an email confirming your active subscription with instructions on how to view and manage your api subscription keys. In addition we will provide you with your Tenant Id which is required to be sent in all api requests via the x-nts-tenant-id http header in addition to your subscription key.
\nEach environment has it's own api endpoint url as noted below.
\nDevelopment Environment: https://api-dev.nts.web.com
\nProduction Environment: https://api.nts.web.com
\nMake sure you can access and successfully call our healthcheck api (see below)
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"321243","collectionId":"49385bb1-0783-41dd-bc38-a7b9b2ace81d","publishedId":"T1DwdZvr","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-09-20T20:39:16.000Z"},"item":[{"name":"Authorization","item":[{"name":"Get OAuth2 Token","event":[{"listen":"test","script":{"id":"3d341872-eb3d-40a1-bdad-6bc4ffb73e96","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", data.access_token);",""],"type":"text/javascript"}}],"id":"cc260cf9-8a6a-4ba2-bed8-cb9385a6a682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Cache-Control","value":"no-cache"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","description":"(Required)
\n"},{"key":"client_id","value":"{{client_id}}","type":"text","description":"(Required)
\n"},{"key":"client_secret","value":"{{client_secret}}","type":"text","description":"(Required)
\n"},{"key":"resource","value":"api://intl.web.com","type":"text"}]},"url":"https://login.microsoftonline.com/03fbebc8-de8a-4428-b573-4c4903610dac/oauth2/token","urlObject":{"protocol":"https","path":["03fbebc8-de8a-4428-b573-4c4903610dac","oauth2","token"],"host":["login","microsoftonline","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc260cf9-8a6a-4ba2-bed8-cb9385a6a682"}],"id":"6104fb93-1532-4b2c-9194-f1f2396b248b","_postman_id":"6104fb93-1532-4b2c-9194-f1f2396b248b","description":""},{"name":"Domain Registration","item":[{"name":"Check","event":[{"listen":"test","script":{"id":"d5e9c64f-54b7-4829-b873-4fc9ce4b4e9d","exec":["tests[\"X-SecurityService-ClientRequestId is present\"] = responseHeaders.hasOwnProperty(\"X-SecurityService-ClientRequestId\");",""],"type":"text/javascript"}}],"id":"728213ba-3e9d-4bec-b737-5e42abc8e30c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","type":"text"},{"key":"tenant-name","value":"{{tenant_name}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api_gateway_url}}/api/domain/check/test.com","description":"Check to see if a domain name is available for registration
\n","urlObject":{"path":["api","domain","check","test.com"],"host":["{{api_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"728213ba-3e9d-4bec-b737-5e42abc8e30c"},{"name":"Spin","event":[{"listen":"test","script":{"id":"cc51a2b7-903d-41fa-9d0b-0fb96fd95a01","exec":["tests[\"X-SecurityService-ClientRequestId is present\"] = responseHeaders.hasOwnProperty(\"X-SecurityService-ClientRequestId\");",""],"type":"text/javascript"}}],"id":"c53f9968-3d6d-402c-8ac4-884f6957d0d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","type":"text"},{"key":"tenant-name","value":"{{tenant_name}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"subdomain\": \"test\",\r\n \"extensions\": \r\n [\r\n \"com\",\r\n \"net\",\r\n \"org\"\r\n ]\r\n}"},"url":"{{api_gateway_url}}/api/domain/spin","description":"Get a list of available domain names given partial words
\n","urlObject":{"path":["api","domain","spin"],"host":["{{api_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c53f9968-3d6d-402c-8ac4-884f6957d0d4"}],"id":"b9c78ac5-32cf-45d4-8cda-b447b45197dc","_postman_id":"b9c78ac5-32cf-45d4-8cda-b447b45197dc","description":""},{"name":"Health Check","item":[{"name":"Healthcheck","event":[{"listen":"test","script":{"id":"6d4da3b0-6701-4b8e-af07-0c3987276e5a","exec":[""],"type":"text/javascript"}}],"id":"dfcb76c1-c315-47ab-b7b1-719060e5193c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"}],"url":"{{api_gateway_url}}/healthcheck","description":"Sends a healthcheck request to see if the sales order api is currently running. This is a simple request that just verifies that the api is up. It does not verify that all dependant systems are reachable.
\n","urlObject":{"path":["healthcheck"],"host":["{{api_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfcb76c1-c315-47ab-b7b1-719060e5193c"}],"id":"b3a3c87b-2738-4641-9a51-68b710ce4873","description":"A health check is the preferred way to know if the sales order api is currently available.
\n","_postman_id":"b3a3c87b-2738-4641-9a51-68b710ce4873"},{"name":"Sales Orders","item":[{"name":"Create A Sales Order","event":[{"listen":"prerequest","script":{"id":"51c60b1c-11a9-4a5b-b4ea-3430fe1d5db4","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"80cf192f-6930-4eb4-a20c-e39f5204a65f","exec":[""],"type":"text/javascript"}}],"id":"89665a57-a12b-47f8-8701-ad10414a31a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"body":{"mode":"raw","raw":"{\r\n\t\r\n \"traceId\": \"abc123\",\r\n \"salesOrder\": {\r\n \"account\": {\r\n \"id\": \"\",\r\n \"name\": \"My Blog\"\r\n },\r\n \"contacts\": [\r\n {\r\n \"address1\": \"123 Any Street\",\r\n \"address2\": \"\",\r\n \"city\": \"Atlanta\",\r\n \"countryCode\": \"US\",\r\n \"email\": \"wes@example.com\",\r\n \"firstName\": \"Wes\",\r\n \"languageCode\": \"en\",\r\n \"lastName\": \"Shaddix\",\r\n \"phoneNumber\": \"+44.1253354576\",\r\n \"postalCode\": \"FY1 2RP\",\r\n \"stateOrProvince\": \"Lancashire\",\r\n \"isInvoiceRecipient\": false,\r\n \"roles\": [\r\n \"Owner\",\r\n \"Marketing\",\r\n \"Finance\",\r\n \"Legal\",\r\n \"Accounting\",\r\n \"General Manager\"\r\n ]\r\n }\r\n ],\r\n \"customer\": {\r\n \"address1\": \"123 Any Street\",\r\n \"address2\": \"\",\r\n \"city\": \"Atlanta\",\r\n \"countryCode\": \"US\",\r\n \"email\": \"wes-1775294474@example.com\",\r\n \"firstName\": \"Wes\",\r\n \"languageCode\": \"en\",\r\n \"lastName\": \"Shaddix\",\r\n \"phoneNumber\": \"+44.1253354576\",\r\n \"postalCode\": \"FY1 2RP\",\r\n \"stateOrProvince\": \"Lancashire\",\r\n \"id\": \"\",\r\n \"username\": \"wshaddix-1775294474\",\r\n \"companyName\": \"Web.com\",\r\n \"customerType\": \"Person\",\r\n \"legalId\": \"ABC1234\"\r\n },\r\n \"notes\": [\r\n {\r\n \"body\": \"This is a sample note\",\r\n \"createdByUsername\": \"WShaddix\"\r\n }\r\n ],\r\n \"paymentSummary\": {\r\n \"currencyCode\": \"usd\",\r\n \"invoiceDeliveryMethod\":\"email\",\r\n \"paymentTerms\":\"50% setup fee + 3 monthly payments\",\r\n \"paymentType\": \"debit card\"\r\n },\r\n \"products\": [\r\n {\r\n \"autoRenewServiceAgreement\": false,\r\n \"discountPercent\": 0,\r\n \"name\": \"Trial Website\",\r\n \"quantity\": 1,\r\n \"serviceAgreementLength\": 12,\r\n \"serviceAgreementUnit\": \"Month\"\r\n }\r\n ],\r\n \"status\": {\r\n \"pipelinePhase\": \"Sales Lead\",\r\n \"salesPartner\": \"Web.com - UK\",\r\n \"salesRep\": \"Wes Shaddix\"\r\n }\r\n }\r\n}"},"url":"{{api_gateway_url}}/sales-orders/v1/","description":"When you are creating a sales order for a new customer you must provide all of the customer and account details.
\nWhen you are creating a sales order for an existing customer you can just provide the customer id. You still have the option of placing the products on a new or existing Account.
\n","urlObject":{"path":["sales-orders","v1",""],"host":["{{api_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"89665a57-a12b-47f8-8701-ad10414a31a3"},{"name":"Create A Sales Order With No Products","event":[{"listen":"test","script":{"id":"82fdb6e9-7d0f-42b9-bb64-74735c653e7c","exec":[""],"type":"text/javascript"}}],"id":"f935a6c6-550d-4e65-9054-f8055e87fd58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"body":{"mode":"raw","raw":"{\r\n\t\"traceId\": \"abc123\",\r\n\t\"salesOrder\": {\r\n\t\"account\": {\r\n\t\t\"id\": \"27d84bd1\",\r\n\t\t\"name\": \"My Blog\"\r\n },\r\n \"contacts\": [\r\n {\r\n\t\t\"address1\": \"123 Any Street\",\r\n\t\t\"address2\": \"\",\r\n\t\t\"city\": \"Atlanta\",\r\n\t\t\"countryCode\": \"US\",\r\n\t\t\"email\": \"wes@example.com\",\r\n\t\t\"firstName\": \"Wes\",\r\n\t\t\"languageCode\": \"en\",\r\n\t\t\"lastName\": \"Shaddix\",\r\n\t\t\"phoneNumber\": \"+44.1253354576\",\r\n\t\t\"postalCode\": \"FY1 2RP\",\r\n\t\t\"stateOrProvince\": \"Lancashire\",\r\n\t\t\"isInvoiceRecipient\": false,\r\n\t\t\"roles\": [\r\n\t\t\t\"Owner\",\r\n\t\t\t\"Marketing\",\r\n\t\t\t\"Finance\",\r\n\t\t\t\"Legal\",\r\n\t\t\t\"Accounting\",\r\n\t\t\t\"General Manager\"\r\n ]\r\n }\r\n ],\r\n \"customer\": {\r\n\t\t\"address1\": \"123 Any Street\",\r\n\t\t\"address2\": \"\",\r\n\t\t\"city\": \"Atlanta\",\r\n\t\t\"countryCode\": \"US\",\r\n\t\t\"email\": \"wes@example.com\",\r\n\t\t\"firstName\": \"Wes\",\r\n\t\t\"languageCode\": \"en\",\r\n\t\t\"lastName\": \"Shaddix\",\r\n\t\t\"phoneNumber\": \"+44.1253354576\",\r\n\t\t\"postalCode\": \"FY1 2RP\",\r\n\t\t\"stateOrProvince\": \"Lancashire\",\r\n\t\t\"id\": \"27d84bd1\",\r\n\t\t\"username\": \"wshaddix\",\r\n\t\t\"companyName\": \"Web.com\",\r\n\t\t\"customerType\": \"Person\",\r\n\t\t\"legalId\": \"ABC1234\"\r\n },\r\n \"notes\": [\r\n {\r\n\t\t\"body\": \"This is a sample note\",\r\n\t\t\"createdByUsername\": \"WShaddix\"\r\n }\r\n ],\r\n \"paymentSummary\": {\r\n\t\t\"currencyCode\": \"usd\",\r\n\t\t\"invoiceDeliveryMethod\":\"email\",\r\n\t\t\"paymentTerms\":\"50% setup fee + 3 monthly payments\",\r\n\t\t\"paymentType\": \"debit card\"\r\n },\r\n \"products\":[],\r\n \"status\": {\r\n\t\t\"pipelinePhase\": \"Sales Lead\",\r\n\t\t\"salesPartner\": \"Web.com - UK\",\r\n\t\t\"salesRep\": \"Wes Shaddix\"\r\n }\r\n }\r\n}"},"url":"{{api_gateway_url}}/sales-orders/v1/","description":"When you are creating a sales order for a new customer you must provide all of the customer and account details.
\nWhen you are creating a sales order for an existing customer you can just provide the customer id. You still have the option of placing the products on a new or existing Account.
\n","urlObject":{"path":["sales-orders","v1",""],"host":["{{api_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f935a6c6-550d-4e65-9054-f8055e87fd58"},{"name":"Get A Sales Order By Id","event":[{"listen":"test","script":{"id":"41f3359d-2891-47f7-8e6d-7ea6ef9cb4ee","exec":[""],"type":"text/javascript"}}],"id":"e7ee9c9b-faf7-435e-835d-7298ba7ed4da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"url":"{{api_gateway_url}}/sales-orders//v1/{{salesOrderId}}?traceId=abc123","description":"Retrieves a sales order details by its id
\n","urlObject":{"path":["sales-orders","","v1","{{salesOrderId}}"],"host":["{{api_gateway_url}}"],"query":[{"key":"traceId","value":"abc123"}],"variable":[]}},"response":[],"_postman_id":"e7ee9c9b-faf7-435e-835d-7298ba7ed4da"},{"name":"Update A Sales Order","event":[{"listen":"test","script":{"id":"04c687fb-290a-4931-9365-27486f4d8f51","exec":[""],"type":"text/javascript"}}],"id":"5e3a92bb-435d-42a6-b4f6-6cbf10012236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"body":{"mode":"raw","raw":"{\r\n \"traceId\": \"abc123\",\r\n \"salesOrder\": {\r\n \"notes\": [\r\n {\r\n \"body\": \"This is a sample note\",\r\n \"createdByUsername\": \"WShaddix\"\r\n }\r\n ],\r\n \"account\": {\r\n \"id\": \"27d84bd1\",\r\n \"name\": \"My Blog\"\r\n },\r\n \"contacts\": [\r\n {\r\n \"firstName\": \"Wes\",\r\n \"lastName\": \"Shaddix\",\r\n \"email\": \"wes@example.com\",\r\n \"phoneNumber\": \"+44.1253354576\",\r\n \"languageCode\": \"en\",\r\n \"address1\": \"123 Any Street\",\r\n \"address2\": \"\",\r\n \"city\": \"Atlanta\",\r\n \"stateOrProvince\": \"Lancashire\",\r\n \"postalCode\": \"FY1 2RP\",\r\n \"countryCode\": \"US\",\r\n \"roles\": [\r\n \"Owner\",\r\n \"Marketing\",\r\n \"Finance\",\r\n \"Legal\",\r\n \"Accounting\",\r\n \"General Manager\"\r\n ]\r\n }\r\n ],\r\n \"customer\": {\r\n \"firstName\": \"Wes\",\r\n \"lastName\": \"Shaddix\",\r\n \"email\": \"wes@example.com\",\r\n \"phoneNumber\": \"+44.1253354576\",\r\n \"languageCode\": \"en\",\r\n \"address1\": \"123 Any Street\",\r\n \"address2\": \"\",\r\n \"city\": \"Atlanta\",\r\n \"stateOrProvince\": \"Lancashire\",\r\n \"postalCode\": \"FY1 2RP\",\r\n \"countryCode\": \"US\",\r\n \"id\": \"27d84bd1\",\r\n \"username\": \"wshaddix\",\r\n \"companyName\": \"Web.com\",\r\n \"customerType\": \"Person\",\r\n \"legalId\": \"ABC1234\"\r\n },\r\n \"products\": [\r\n {\r\n \"name\": \"Trial Website Bundle\",\r\n \"qty\": 1,\r\n \"discountPercent\": 15,\r\n \"serviceAgreementLength\": 1,\r\n \"serviceAgreementUnit\": \"Month\"\r\n }\r\n ],\r\n \"status\": {\r\n \"salesPartner\": \"LocalWorld\",\r\n \"salesRep\": \"Wes Shaddix\",\r\n \"pipelinePhase\": \"Sales Lead\"\r\n }\r\n }\r\n}"},"url":"{{api_gateway_url}}/sales-orders/v1/{{salesOrderId}}?traceId=abc123","description":"Updates an existing sales order by replacing the existing sales order's value with the values that you pass into the api. If you do not pass all of the properties then the existing sales order will retain it's original values for those properties.
\n","urlObject":{"path":["sales-orders","v1","{{salesOrderId}}"],"host":["{{api_gateway_url}}"],"query":[{"key":"traceId","value":"abc123"}],"variable":[]}},"response":[],"_postman_id":"5e3a92bb-435d-42a6-b4f6-6cbf10012236"},{"name":"List Sales Orders By Pipeline Phase","event":[{"listen":"test","script":{"id":"1fc287e8-5ada-43b4-b937-ab7213221cc7","exec":[""],"type":"text/javascript"}}],"id":"5c3ddc95-b691-421c-854d-7eaf7654cdf4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"url":"{{api_gateway_url}}/sales-orders/v1?page=1&pageSize=10&sortBy=createdOnUtc","description":"List sales orders that are in a given pipeline phase
\n","urlObject":{"path":["sales-orders","v1"],"host":["{{api_gateway_url}}"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"},{"key":"sortBy","value":"createdOnUtc"},{"disabled":true,"key":"Status","value":null}],"variable":[]}},"response":[],"_postman_id":"5c3ddc95-b691-421c-854d-7eaf7654cdf4"},{"name":"List Non-Processed Sales Orders","event":[{"listen":"test","script":{"id":"dd4f7f49-9922-4953-803c-071dd293539c","exec":[""],"type":"text/javascript"}}],"id":"420cd05f-7388-46ed-b624-e35ffbf65ebf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"url":"{{api_gateway_url}}/sales-orders/v1?page=1&pageSize=10&sortBy=-createdOnUtc&processed=false","description":"Returns a list of sales orders that have not yet been processed.
\n","urlObject":{"path":["sales-orders","v1"],"host":["{{api_gateway_url}}"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"},{"key":"sortBy","value":"-createdOnUtc"},{"disabled":true,"key":"Status","value":null},{"key":"processed","value":"false"}],"variable":[]}},"response":[],"_postman_id":"420cd05f-7388-46ed-b624-e35ffbf65ebf"},{"name":"List Sales Orders By Sales Partner","event":[{"listen":"test","script":{"id":"6e704bc9-d4da-479f-9a38-bcfc2cace59b","exec":[""],"type":"text/javascript"}}],"id":"58c2dcaa-d451-4417-b1cb-df2a74bf5dd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"url":"{{api_gateway_url}}/sales-orders/v1?pageSize=10&sortBy=createdOnUtc&page=1&criteria=Web.com%20-%20UK","description":"List sales orders that belong to the given sales partner
\n","urlObject":{"path":["sales-orders","v1"],"host":["{{api_gateway_url}}"],"query":[{"key":"pageSize","value":"10"},{"key":"sortBy","value":"createdOnUtc"},{"key":"page","value":"1"},{"disabled":true,"key":"Status","value":null},{"key":"criteria","value":"Web.com%20-%20UK"}],"variable":[]}},"response":[],"_postman_id":"58c2dcaa-d451-4417-b1cb-df2a74bf5dd4"},{"name":"List Sales Orders By Sales Rep","event":[{"listen":"test","script":{"id":"a6e37269-ae84-4d4b-91c8-a71cebf3f082","exec":[""],"type":"text/javascript"}}],"id":"65373292-9202-4d05-b2eb-3e41cd58e005","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"url":"{{api_gateway_url}}/sales-orders/v1?pageSize=10&criteria=Wes%20Shaddix&sortBy=createdOnUtc&page=1","description":"List sales orders that were sold by a given sales rep
\n","urlObject":{"path":["sales-orders","v1"],"host":["{{api_gateway_url}}"],"query":[{"key":"pageSize","value":"10"},{"key":"criteria","value":"Wes%20Shaddix"},{"key":"sortBy","value":"createdOnUtc"},{"key":"page","value":"1"},{"disabled":true,"key":"Status","value":null}],"variable":[]}},"response":[],"_postman_id":"65373292-9202-4d05-b2eb-3e41cd58e005"},{"name":"List Sales Orders By Account Name","event":[{"listen":"test","script":{"id":"e570e01a-d4ac-4d5d-a456-35c9e87908a0","exec":[""],"type":"text/javascript"}}],"id":"a5fae985-472e-4213-8c41-364fcf3bf961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"url":"{{api_gateway_url}}/sales-orders/v1?pageSize=10&criteria=My%20Blog&sortBy=createdOnUtc&page=1","description":"List sales orders who's account has the given name
\n","urlObject":{"path":["sales-orders","v1"],"host":["{{api_gateway_url}}"],"query":[{"key":"pageSize","value":"10"},{"key":"criteria","value":"My%20Blog"},{"key":"sortBy","value":"createdOnUtc"},{"key":"page","value":"1"},{"disabled":true,"key":"Status","value":null}],"variable":[]}},"response":[],"_postman_id":"a5fae985-472e-4213-8c41-364fcf3bf961"},{"name":"Delete A Sales Order By Id","event":[{"listen":"test","script":{"id":"d7adf208-cce5-4cb3-aa30-c439561dce8f","exec":[""],"type":"text/javascript"}}],"id":"40662631-9b1b-4aee-91e5-2e155419c9ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","description":"(Required)
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"Authorization","value":"bearer {{token}}","description":"(Required) This is your auth token that you would receive from the Authorization call
\n"},{"key":"x-nts-tenant-id","value":"{{tenant_id}}","description":"(Required) This is your company's unique identifier
\n"}],"body":{"mode":"raw","raw":""},"url":"{{api_gateway_url}}/sales-orders/v1/{{salesOrderId}}","description":"Deletes a sales order by its Id
\n","urlObject":{"path":["sales-orders","v1","{{salesOrderId}}"],"host":["{{api_gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40662631-9b1b-4aee-91e5-2e155419c9ec"}],"id":"17f351b4-ac2a-4778-9f9d-f2dece6b0bd6","description":"Sales orders capture information about the sale of products to new or existing Customers. They allow you to attribute the sale to a given sales rep (for commission) as well as specify a sales partner (for when you are fulfilling websites on behalf of another company).
\nSales orders can go through various pipeline phases so that you can track the progression of the sales funnel as you work with the customers. The pipeline phases are:
\nYou can create sales orders for new or existing customers. If you are working with an existing customer then you can simply supply the customer's email address and NTS can uniquely identify the customer. If you are working with a new customer then you must supply all required customer information so that NTS can create a new customer in the system.
\nEvery customer in NTS has one or more accounts. An account is a container that holds all of the products and services that are purchased and provisioned on a sales order. A customer can have more than one account if they choose. For example, a customer may have one \"Business\" account where he/she has his company's website, email and ppc service and a second \"Personal\" account where he/she maintains their personal blog.
\nAny product that has been configured in your tenant's product catalog can be placed on the sales order. The products can be identified by their product name as that is unique in NTS for your tenant.
\nFinally, payment information is collected. As of today, this is for informational purposes only as NTS does not integrate with a payment processor. You must secure payment from the customer by other means and then set the status of the sales order to paid in order for it to provision services.
\n","_postman_id":"17f351b4-ac2a-4778-9f9d-f2dece6b0bd6"},{"name":"SSO","item":[{"name":"Customer Get Sso","event":[{"listen":"test","script":{"id":"92ab757b-56eb-489f-b48a-7d46475276ae","exec":[""],"type":"text/javascript"}}],"id":"c98f74b3-e6fb-4672-8106-80ea5dd2ede4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api_subscription_key}}","type":"text","description":"(Required) Your api access key from the developer portal that identifies your subscription to the api
\n"},{"key":"tenant-name","value":"{{tenant_name}}","type":"text","description":"(Required) This is your tenant's name
\n"},{"key":"Content-Type","value":"application/json","type":"text","description":"(Required)
\n"}],"url":"{{api_gateway_url}}/sso/{{customer_id}}","description":"This generates a sso url for any given customer owned by your tenant.
\n{{api_gateway_url}}/sso/:customer_id\n