{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e4c2ceba-6f68-4a5b-beec-70d6a4d82425","name":"Cloud Commerce Pro API","description":"* * *\n\n**Please address any api related queries to** **support@cloudcommercepro.com**\n\n**Please note the Cloud Commerce Pro codebase in the Sandbox Environment is refreshed at regular intervals which means you may experience issues logging into the Sandbox Web Interface for approximately 30 minutes at 7am each day**\n\n## Getting Started\n\nTo begin using the API you will need a **BrandID** and a **Security Hash**.\n\nTo obtain one of these please contact your Project Manager at Cloud Commerce Pro.\n\n## Php Developers\n\nWe have made some sample scripts avaiable here: [https://github.com/markmorganatccp/ccpapi-php](https://github.com/markmorganatccp/ccpapi-php)\n\n**PLEASE NOTE THESE ARE FOR TESTING PURPOSES ONLY**\n\n## Sandbox\n\nTo avoid testing against *live* data please use the Endpoints marked **SANDBOX URL**. This data is overwritten every 24 hours.\n\nTo Access your Sandbox Web UI use the same credentials as for your live system and prefix the URL with \"dev-\".\n\n### Example:\n\n#### Live:\n\nhttps://{your live prefix}.cloudcommercepro.com/\n\n#### Sandbox:\n\n[https://dev-{your](https://dev-{your) live prefix}.cloudcommercepro.com/\n\n## Endpoints\n\n### Product Options\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductOptionService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductOptionService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductOptionService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductOptionService.svc?wsdl)\n\nProduct Options cover such things as Brand Name, Product Type Name e.g. Trainers, Size, Material and Colour. In Cloud Commerce this feature is accessed via the PRODUCT OPTIONS button on the Landing Page.\n\n### Product Ranges\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductRangeService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductRangeService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductRangeService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductRangeService.svc?wsdl)\n\nThe various types of product, for example, trainers, t-shirts.\n\n### Products\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductsService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductsService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductsService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductsService.svc?wsdl)\n\nIndividual product variations e.g. Mens Adidas Trainers, blue, size 9.\n\n### Sales Channels\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiSalesChannelService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiSalesChannelService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiSalesChannelService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiSalesChannelService.svc?wsdl)\n\nManaging Prices and Products on a given Sales Channel.\n\n### Customers\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiCustomerService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiCustomerService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiCustomerService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiCustomerService.svc?wsdl)\n\nManage Customer Information.\n\n### Orders\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiOrderService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiOrderService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiOrderService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiOrderService.svc?wsdl)\n\nManage all aspects of order processing.\n\n### Payments\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiPaymentService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiPaymentService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CCPApiPaymentService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CCPApiPaymentService.svc?wsdl)\n\nUsed mainly for paying order invoices to push orders to the dispatch queue.\n\n### Transactions\n\n**SANDBOX URL**: [https://devwcfccpservicesbase.cloudcommercepro.com/CcpApiTransactionService.svc?wsdl](https://devwcfccpservicesbase.cloudcommercepro.com/CcpApiTransactionService.svc?wsdl)\n\n**LIVE URL**: [https://wcfccpservicesbase.cloudcommercepro.com/CcpApiTransactionService.svc?wsdl](https://wcfccpservicesbase.cloudcommercepro.com/CcpApiTransactionService.svc?wsdl)\n\nObtain a list of Financial Transactions for a given time period.\n\n## API Structures\n\n* * *\n\nAll Request and Response Objects in the CCP API derive from these base objects.\n\n### Request\n\n* * *\n\n<table><tbody><tr><td>BrandID</td><td></td><td>Your unique identifier in CCP</td><td></td></tr><tr><td>Security Hash</td><td></td><td>Your api key</td><td></td></tr><tr><td>Content</td><td></td><td>The Parameters making up the Body of the SOAP request</td><td></td></tr></tbody></table>\n\n### Response\n\n* * *\n\n<table><tbody><tr><td>Success</td><td>boolean as to success of request</td></tr><tr><td>ErrorLevel</td><td>Error Code - see below</td></tr><tr><td>Content</td><td>Main Body of SOAP Response</td></tr><tr><td>Errors</td><td>List of any errors to aid with debugging - see below</td></tr></tbody></table>\n\n### Errors\n\n* * *\n\n### Fault Types\n\n<table><tbody><tr><th>Fault Type</th><th></th></tr><tr><td>AuthenticationFault</td><td>Invalid Credentials</td></tr><tr><td>AuthorizationFault</td><td>Not authorized for this action</td></tr><tr><td>ValidationFault</td><td>Invalid Data in request</td></tr><tr><td>General</td><td>Unkown error</td></tr></tbody></table>\n\n#### Error Codes\n\n<table><tbody><tr><th>Error Code</th><th></th></tr><tr><td>InvalidBrandID</td><td>Invalid BrandID</td></tr><tr><td>InvalidID</td><td>Record ID not valid for your Brand</td></tr><tr><td>RecordAlreadyExists</td><td>Attempt to add duplicate data</td></tr><tr><td>MissingRequiredData</td><td>Required Data is missing from the request</td></tr><tr><td>ObjectNotFound</td><td>Record not found</td></tr><tr><td>InvalidData</td><td>The request contains invalid data</td></tr><tr><td>GeneralException</td><td>Something went wrong with the request during processing</td></tr></tbody></table>\n\nIf you receive a response like this:\n\n``` xml\n            a:InternalServiceFault\n            The server was unable to process the request due to an internal error.  For more information about the error, either turn on IncludeExceptionDetailInFaults (either from ServiceBehaviorAttribute or from the  configuration behavior) on the server in order to send the exception information back to the client, or turn on tracing as per the Microsoft .NET Framework SDK documentation and inspect the server trace logs.\n\n```\n\nThis usually means that there is an issue with the data you are sending, usually this is either data of the wrong type or there are empty nodes in the request e.g tem:CustomerID/. Usually if you either populate these with a default value or remove them altogether this will resolve the issue.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4315995","team":203710,"collectionId":"e4c2ceba-6f68-4a5b-beec-70d6a4d82425","publishedId":"RWaRNk7b","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4315995/RWaRNk7b","privateUrl":"https://go.postman.co/documentation/4315995-e4c2ceba-6f68-4a5b-beec-70d6a4d82425","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2018-09-26T16:07:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/309a5bbded141c406bd9968e56aced18cfc09a1ba073dfc35e3a9eaf9c8f4e48","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RWaRNk7b"}