{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"955d3568-e71d-4dff-9caf-c10bed8c6f13","name":"Cloud Commerce Pro API v3","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## 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 but change the url as follows:\n\n### Example:\n\n#### Live:\n\n[https://api.cloudcommercepro.com/3/0](https://api.cloudcommercepro.com/3/0)\n\n#### Sandbox:\n\n[https://api-dev.cloudcommercepro.com/3/0](https://api-dev.cloudcommercepro.com/3/0)\n\n## Endpoints\n\nwhere {{APIUrl}} is one of the URLs listed above...\n\n
ServiceEndpoint
Customer Orders{{APIUrl}}/CustomerOrders.svc?wsdl
Order Shipments{{APIUrl}}/OrderShipments.svc?wsdl
Purchase Orders{{APIUrl}}/PurchaseOrders.svc?wsdl
\n\n## API Structures\n\nAll Request and Response Objects in the CCP API derive from these base objects.\n\n### Request\n\n* * *\n\n
BrandIDYour unique identifier in CCP
Security HashYour api key
ContentThe Parameters making up the Body of the SOAP request
\n\n### Response\n\n* * *\n\n
Successboolean as to success of request
ErrorLevelError Code - see below
ContentMain Body of SOAP Response
ErrorsList of any errors to aid with debugging - see below
\n\n### Errors\n\n* * *\n\n### Fault Types\n\n
Fault Type
AuthenticationFaultInvalid Credentials
AuthorizationFaultNot authorized for this action
ValidationFaultInvalid Data in request
GeneralUnkown error
\n\n#### Error Codes\n\n
Error Code
InvalidBrandIDInvalid BrandID
InvalidIDRecord ID not valid for your Brand
RecordAlreadyExistsAttempt to add duplicate data
MissingRequiredDataRequired Data is missing from the request
ObjectNotFoundRecord not found
InvalidDataThe request contains invalid data
GeneralExceptionSomething went wrong with the request during processing
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4315995","team":203710,"collectionId":"955d3568-e71d-4dff-9caf-c10bed8c6f13","publishedId":"RzfZNXy5","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4315995/RzfZNXy5","privateUrl":"https://go.postman.co/documentation/4315995-955d3568-e71d-4dff-9caf-c10bed8c6f13","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-11-22T14:50:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"TestApiV3","id":"97bd69aa-1d5c-4829-85af-1b19506677c2","owner":"4315995","values":[{"key":"test","value":"34,191,96,123,71,220,212,14,93,58,107,184,154,202,26,215,183,8,13,182,212,83,138,243,111,170,200,193,253,80,231,21,82,165,94,67,164,24,31,202,156,106,52,84,15,191,192,93,29,150,224,232,25,77,140,243,38,24,121,230,22,37,69,190,74,177,231,70,118,113,103,196,172,223,130,31,12,8,31,154,29,208,37,95,255,159,108,194,6,25,58,105,56,18,218,80,253,207,46,253,59,197,247,231,212,198,79,236,31,125,87,146,6,249,236,206,197,187,76,80,15,213,30,177,123,31,170,18","description":"","enabled":false}],"published":true}],"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"},{"label":"TestApiV3","value":"4315995-97bd69aa-1d5c-4829-85af-1b19506677c2"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RzfZNXy5"}