Please address any api related queries to support@cloudcommercepro.com
\nPlease 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
\nTo begin using the API you will need a BrandID and a Security Hash.
\nTo obtain one of these please contact your Project Manager at Cloud Commerce Pro.
\nWe have made some sample scripts avaiable here: https://github.com/markmorganatccp/ccpapi-php
\nPLEASE NOTE THESE ARE FOR TESTING PURPOSES ONLY
\nTo avoid testing against live data please use the Endpoints marked SANDBOX URL. This data is overwritten every 24 hours.
\nTo Access your Sandbox Web UI use the same credentials as for your live system and prefix the URL with \"dev-\".
\nhttps://{your live prefix}.cloudcommercepro.com/
\nhttps://dev-{your live prefix}.cloudcommercepro.com/
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductOptionService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductOptionService.svc?wsdl
\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.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductRangeService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductRangeService.svc?wsdl
\nThe various types of product, for example, trainers, t-shirts.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiProductsService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiProductsService.svc?wsdl
\nIndividual product variations e.g. Mens Adidas Trainers, blue, size 9.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiSalesChannelService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiSalesChannelService.svc?wsdl
\nManaging Prices and Products on a given Sales Channel.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiCustomerService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiCustomerService.svc?wsdl
\nManage Customer Information.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiOrderService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiOrderService.svc?wsdl
\nManage all aspects of order processing.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CCPApiPaymentService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CCPApiPaymentService.svc?wsdl
\nUsed mainly for paying order invoices to push orders to the dispatch queue.
\nSANDBOX URL: https://devwcfccpservicesbase.cloudcommercepro.com/CcpApiTransactionService.svc?wsdl
\nLIVE URL: https://wcfccpservicesbase.cloudcommercepro.com/CcpApiTransactionService.svc?wsdl
\nObtain a list of Financial Transactions for a given time period.
\nAll Request and Response Objects in the CCP API derive from these base objects.
\n| BrandID | Your unique identifier in CCP | ||
| Security Hash | Your api key | ||
| Content | The Parameters making up the Body of the SOAP request |
| Success | boolean as to success of request |
| ErrorLevel | Error Code - see below |
| Content | Main Body of SOAP Response |
| Errors | List of any errors to aid with debugging - see below |
| Fault Type | |
|---|---|
| AuthenticationFault | Invalid Credentials |
| AuthorizationFault | Not authorized for this action |
| ValidationFault | Invalid Data in request |
| General | Unkown error |
| Error Code | |
|---|---|
| InvalidBrandID | Invalid BrandID |
| InvalidID | Record ID not valid for your Brand |
| RecordAlreadyExists | Attempt to add duplicate data |
| MissingRequiredData | Required Data is missing from the request |
| ObjectNotFound | Record not found |
| InvalidData | The request contains invalid data |
| GeneralException | Something went wrong with the request during processing |
If you receive a response like this:
\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\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.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4315995","collectionId":"e4c2ceba-6f68-4a5b-beec-70d6a4d82425","publishedId":"RWaRNk7b","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-09-26T16:07:39.000Z"},"item":[{"name":"Product Options","item":[{"name":"getAvailableProductOptions","id":"6876f9e4-24f0-4c0e-b934-8332dc494e6a","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"wcfproductoptions.cloudcommercepro.com/CCPProductOptions/getAvailableProductOptions"}],"body":{"mode":"raw","raw":"Get Available Product Options
\n","urlObject":{"path":["CCPApiProductOptionService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[{"id":"3d2e7ae9-f01a-4a54-b489-91e5ef469faa","name":"getAvailableProductOptions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"wcfproductoptions.cloudcommercepro.com/CCPProductOptions/getAvailableProductOptions"}],"body":{"mode":"raw","raw":"Get Available Product Options
\n","urlObject":{"path":["CCPApiProductOptionService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"308dcb26-6cd1-4deb-ba2a-fb08c588f196","name":"Get Available Product Options - Succesful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","warning":""},{"key":"SOAPAction","value":"wcfproductoptions.cloudcommercepro.com/CCPProductOptions/getAvailableProductOptions","warning":""}],"body":{"mode":"raw","raw":"Represents the available values for an APIProductOption. For example for the APIProductOption \"Colour\", APIProductRangeOptionValues may include Blue, Red, Green.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for APIProductRangeOptionValue | \n
| BrandID | \nint | \nUnique identifier for Brand | \n
| OptionID | \nint | \nUnique Identifier for the APIProductOption | \n
| OptionValue | \nString | \nThe Value e.g. (Option = Colour, Value = Blue) | \n
| OptionSortOrder | \nint | \nSet in the UI in CCP | \n
| OptionName | \nString | \nAPIProductOption Name eg. Colour | \n
Adds a value to a Product Option.
\nFor example if your Master Option is Category and you sell clothing etc you may want to add a new value of Footwear.
\n| Parameter | \nType | \nDefault | \nDetails | \n
|---|---|---|---|
| ID | \nint | \n0 | \nNot required but if included in SOAP message must be set to Default value | \n
| BrandIDr | \nint | \n0 | \nUnique identifier for Brand | \n
| OptionID | \nint | \n0 | \nUnique identifier for Product Option | \n
| OptonName | \nstring | \n\"\" | \nNot required but if included in SOAP message must be set to Default value, null will cause errors | \n
| OptionValue | \nstring | \n\"\" | \nThe value being added | \n
| OptionSortOrder | \nint | \n0 | \nNot required but if included in SOAP message must be set to Default value | \n
Sets product option values for a product variation
\n| Parameter | \nType | \nDefault | \nDetails | \n
|---|---|---|---|
| ProductID | \nint | \n0 | \nUnique identifier for the Product Variation | \n
| OptionID | \nint | \n0 | \nUnique identifier for the Product Option | \n
| ValueID | \nint | \n0 | \nUnique identifier for the Product Option Value | \n
APIProductOption objects represent the Product Options configured in CCP for example Category, Manufacturer, Model, Size.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier for APIProductOption | \n
| OptionName | \nString | \nName of Option e.g. Category | \n
| OptionEbayName | \nString | \nName of Option on Ebay Channels | \n
| OptionAmazonName | \nString | \nName of Option on Amazon Channels | \n
| OptionWebName | \nString | \nName of Option on Website Channels | \n
| OptionSortOrder | \nint | \nInternal use only | \n
| OptionType | \nint | \nType of Option see below * | \n
| Master | \nBoolean | \nWhether or not this is the Master Option NB. This must be set | \n
| Hidden | \nBoolean | \nWhether or not to display the Option in the system | \n
| Status | \nint | \nInternal Use Only | \n
Gets a list of Product Ranges
\nThis request takes a single string paramater, this can be an empty string.
\nReturns List of ProductRangeSummary objects.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for Product Range | \n
| ManufacturerSKU | \nstring | \nStock Keeping Unit | \n
| Name | \nstring | \nRange Name | \n
Adds a new Product Range
\n","urlObject":{"path":["CCPApiProductRangeService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"3fb9d71c-bfac-4167-ac19-d07aef8a20f1","name":"Get Product Ranges - successful response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"wcfproductranges.cloudcommercepro.com/CCPProductRanges/getProductRanges"}],"body":{"mode":"raw","raw":"Deletes Product Range
\n","urlObject":{"path":["CCPApiProductRangeService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"5c67aeaa-7878-469e-a6c6-2733123bde11","name":"Add Product Range","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"wcfproductranges.cloudcommercepro.com/CCPProductRanges/addProductRange"}],"body":{"mode":"raw","raw":"Gets list of Deleted Product Ranges
\n","urlObject":{"path":["CCPApiProductRangeService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"73405a6a-15a9-46f5-8450-a34490c6e1e6","name":"Get Product Ranges - successful response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"wcfproductranges.cloudcommercepro.com/CCPProductRanges/getProductRanges"}],"body":{"mode":"raw","raw":"Links a Product Range to a Product Option. For example link a new range of Trainers to the Colour option.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| OptionID | \nint | \nUnique identifier for Product Option | \n
| ProductRangeID | \nint | \nUnique identifier for Product Range | \n
Sets the Name of a Product Range
\n","urlObject":{"path":["CCPApiProductRangeService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"50d1ce07-3ed6-4e61-81c3-02b54edc6392"},{"name":"setEndOfLine","id":"22b5c167-071b-43a3-a86a-a8da2ef89e97","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"wcfproductranges.cloudcommercepro.com/CCPProductRanges/setName"}],"body":{"mode":"raw","raw":"APIProductRange represents a Product type, for example Men's, Footwear, Trainers, Adidas.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for APIProductRange | \n
| BrandID | \nint | \nUnique identifier for Brand | \n
| CategoryID | \nint | \nDEPRECATED | \n
| Manufacturer | \nString | \nManufacturer Name | \n
| ManufacturerSKU | \nString | \nStock Keeping Unit | \n
| Name | \nString | \nProduct Range Name | \n
| NeckShape | \nString | \n\n |
| EndOfLine | \nBoolean | \n\n |
| PreOrder | \nBoolean | \n\n |
| Weight | \nint | \n\n |
| LastStockCheck | \nDateTime | \n\n |
| GroupBy | \nBoolean | \n\n |
| WarehousePickOrder | \nint | \n\n |
| StatusID | \nStatusID | \n\n |
| options | \nAPIProductRangeOption[] | \n\n |
| products | \nAPIProduct[] | \n\n |
Create a New Product Variation
\nBasic request for adding a Product Variation
\n| Property | \nType | \nDetails | \n
|---|---|---|
| BrandID | \nint | \nUnique identifier for Brand | \n
| ProductRangeID | \nint | \nUnique identifier for Product Range | \n
| Name | \nstring | \nProduct Name | \n
| Description | \nstring | \nProduct description. * | \n
| ManufacturerSKU | \nstring | \nStock Keeping Unit | \n
| DateAdded | \ndatetime | \nDate record created | \n
| VATRateID | \nint | \nUnique identifier for Product Default Tax Rate | \n
| BasePrice | \ndecimal | \nDefault selling price | \n
| ProductType | \nint | \nPass default value of 0 | \n
| SelectedProductRangeOptionValues * | \nAPIProductRangeOptionValue[] | \nProduct Option Values. E.g. Colour - Blue * | \n
Publishes a Product to a Sales Channel setting the Price.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier | \n
| BrandID | \nint | \nUnique Identifier for Brand | \n
| ProductRangeID | \nint | \nUnique Identifier for Product Range | \n
| SalesChannelID | \nint | \nUnique Identifier for Sales Channel | \n
| ProductID | \nint | \nUnique Identifier for Product Variant | \n
| SKU | \nString | \nProduct Variant Stock Keeping Unit | \n
| Price | \nDecimal | \nGross Sales Channel Price | \n
| VATRateID | \nint | \nUnique Identifier for Tax Rate | \n
Gets Paged List of Product Information
\nFor example to get the first 50 products in a list of 600. Start = 0, End = 50
\n| Property | \nType | \nDetails | \n
|---|---|---|
| Start | \nint | \nBegin at this record no. | \n
| End | \nint | \nStop at this record no. | \n
getProductByID
\n","urlObject":{"path":["CCPApiProductsService.svc"],"host":["{{live}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[{"id":"03d9f372-60d1-4915-b633-7f7109ffd711","name":"Add Sales Channel Link Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPAPIProductsService/getProductByExternalProductId"}],"body":{"mode":"raw","raw":"getProductByExternalProductId
\n","urlObject":{"path":["CCPApiProductsService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[{"id":"5ad4e8b3-02af-4104-84f3-fa5f29c03902","name":"Add Sales Channel Link","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPAPIProductsService/getProductByExternalProductId"}],"body":{"mode":"raw","raw":"Publish a Product to a Sales Channel
\n","urlObject":{"path":["CCPApiProductsService.svc"],"host":["{{localhost}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[{"id":"016f4d62-d51d-4b4a-9d12-7458414730d1","name":"Add Sales Channel Link","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPAPIProductsService/getProductByBarcode"}],"body":{"mode":"raw","raw":"Sets the Name of a Product Variation
\n","urlObject":{"path":["CCPApiProductsService.svc"],"host":["{{localhost}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"9f7458b7-9e0a-48f1-a93f-e50dccd1fe90"},{"name":"AddProductImage","id":"7917cd6e-4970-4e70-a70c-9f2d2078b24e","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPAPIProductsService/AddProductImage"}],"body":{"mode":"raw","raw":"Adds Product Images based on Base64 strings
\n","urlObject":{"path":["CCPApiProductsService.svc"],"host":["{{localhost}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"7917cd6e-4970-4e70-a70c-9f2d2078b24e"},{"name":"addStockTransaction","id":"3434b525-aafe-46b6-a719-78006dded8e2","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPAPIProductsService/addStockTransaction"}],"body":{"mode":"raw","raw":"Validation Rules for Product Information
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier of product | \n
| BrandID | \nint | \nUnique identifier for brand | \n
| Name | \nString | \nproduct variation name | \n
| Description | \nString | \nProduct variation description | \n
| ManufacturerSKU | \nString | \nStock keeping unit | \n
| DateAdded | \nDateTime | \nDate and time product added to CCP | \n
| SupplierProductLinks | \nAPIProductSupplierLink[] | \nList of suppliers and prices for this product | \n
| BasePrice | \nDecimal | \nThe default price | \n
| ChannelPrice | \nDecimal | \nSales channel specific price where provided | \n
| VATRateID | \nint | \nUnique identifier for tax rate | \n
| BarCodeNumber | \nString | \nBarcode number | \n
| AdditionalBarCodes | \nString | \nComma separated list of additional barcodes | \n
| ASIN | \nString | \nAamazon serial number | \n
| AmazonVariationID | \nint | \nUnique identifier for amazon variation | \n
| EbayListingID | \nString | \nUnique identifier for ebay listing | \n
| EbayVariationID | \nint | \nUnique identifier for ebay variation | \n
| ProductRangeID | \nint | \nUnique identifier for product range | \n
| PreOrder | \nBoolean | \nWhether the product can be pre-ordered | \n
| EndOfLine | \nBoolean | \nWhether this is the end of the line for this product | \n
| LengthMM | \nint | \nDimensions, length in millimeters | \n
| WidthMM | \nint | \nDimensions, width in millimeters | \n
| HeightMM | \nint | \nDimensions, height in millimeters | \n
| WeightGM | \nint | \nDimensions, weight in millimeters | \n
| LargeLetterCompatible | \nBoolean | \nWhether the product is compatible with being shipped as a large letter | \n
| ProductType | \nint | \n0 = Standard product 1 = Multipack | \n
| ProductVATRate | \nint | \nUnique identifier for product tax rate | \n
| SearchText | \nString | \nSearch phrases | \n
| StatusID | \nStatusID | \nStatus enumerator | \n
| AdditionalShippingLabel | \nBoolean | \nWhether this product has an additional shipping label | \n
| ExternalProductId | \nString | \nReference in external system e.g. Open Cart product id | \n
| Thumbs200x200 | \nString | \nFilename for thumbnail image | \n
| Thumbs75x75 | \nString | \nFilename for thumbnail image | \n
| MatchOptions | \nString | \n\n |
| StockLevel | \nint | \nThe number of units currently in stock | \n
| ChannelPseudoStockLevel | \nint | \nPseudostock level on sales channel when provided | \n
| SelectedProductRangeOptionValues | \nAPIProductRangeOptionValue[] | \nList of APIProductRangeOptionValue eg. size 7, colour blue, category men's trainers | \n
| imageB64Strings | \nString[] | \nArray of 64base strings representing images | \n
| images | \nAPIProductImage[] | \nList of images | \n
| AmazonVariations | \nAPIAmazonVariation] | \nList of amazon variations | \n
| EbayVariations | \n[APIEbayVariation] | \nList of ebay variatins | \n
| packItems | \nPackageProductWithQuantity[] | \nComponent part of pack product | \n
| SalesChannelLinks | \nAPISalesChannelLink[] | \nList of sales channel data for product inluding prices | \n
| PurchaseOrderMaxStock | \nint | \nMaximum amount of stock to order from suppliers | \n
| PurchaseOrderAtStockQuantity | \nint | \nStock level at which to create a new purhase order | \n
| PurchaseOrderStockType | \nint | \n\n |
| PurchaseOrderBoxQuantity | \nint | \n\n |
| ProductStockType | \nint | \n\n |
| DispatchIdentifierOption | \nint | \n\n |
| StockLocations | \nItemBayStockLevel[] | \nWarehouse bay locations of stock units | \n
| OnOrder | \nSupplierOrderItem[] | \nItems on order from suppliers | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for supplier product link record | \n
| ProductID | \nint | \nUnique identifier for product | \n
| SupplierID | \nint | \nUnique identifier for supplier | \n
| SupplierName | \nString | \nName of supplier | \n
| SupplierPrice | \nDecimal | \nPurchase price from supplier | \n
| SupplierPriceDate | \nDateTime | \nDate price provided by supplier | \n
| SupplierSKU | \nString | \nSupplier stock keeping unit | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for record | \n
| BrandID | \nint | \nUnique identifier for Brand | \n
| OptionID | \nint | \nUnique identifier for Product Option | \n
| OptionValue | \nString | \nName of Option Value | \n
| OptionSortOrder | \nint | \nSort order for Product Range Option | \n
| OptionName | \nString | \nName of Product Range Option | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for Image | \n
| ProductID | \nint | \nUnique identifier for Product | \n
| BrandID | \nint | \nUnique identifier for Brand | \n
| strBS64 | \nString | \nBase64 string representation for image data | \n
| FileName | \nString | \nFilename | \n
| FileExtension | \nString | \nFile extension | \n
| URL | \nString | \nImage url | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| AmazonVariationID | \nint | \nUnique identifier for Amazon Variation | \n
| VariationID | \nint | \nUnique identifier for Shop Variation | \n
| Barcode | \nString | \nBarcode | \n
| ASIN | \nString | \nAmazon serial number | \n
| SKU | \nString | \nStock keeping unit | \n
| Stock | \nint | \nQuantity in stock | \n
| Options | \nString | \n\n |
| Property | \nType | \nDetails | \n
|---|---|---|
| EbayVariationID | \nint | \nUnique identifier fro Ebay variation | \n
| VariationID | \nint | \nUnique identifier for Shop Variation | \n
| SKU | \nString | \nStock keeping unit | \n
| Barcode | \nString | \nBarcode | \n
| ListingID | \nString | \nUnique identifier for Ebay listing | \n
| Stock | \nint | \nNo of units in stock | \n
| Options | \nString | \n\n |
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for Sales Channel Link | \n
| BrandID | \nint | \nUnique identifier for Brand | \n
| ProductRangeID | \nint | \nUnique identifier for Product Range | \n
| SalesChannelID | \nint | \nUnique identifier for Sales Channel | \n
| ProductID | \nint | \nUnique identifier for Product | \n
| SKU | \nString | \nStock Keeping Unit for Product | \n
| Price | \nDecimal | \nSales Channel Price | \n
| VATRateID | \nint | \nUnique identifier for Tax Rate | \n
Get Stock Levels By SKU List
\nThe content of the request is a list or array of skus, stock keeping units
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ProductID | \nint | \nUnique identifier for Product | \n
| SKU | \nString | \nStock keeping unit | \n
| ProductName | \nString | \nName of product | \n
| StockLevel | \nint | \nNo of units currently in stock | \n
Adds a bulk list of stock update operations to a jobs queue in CCP.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| StockUpdates | \nAPIUpdateStockRequest[] | \nContainer for List of APIUpdateStockRequest objects | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| SalesChannelID | \nint | \nOptional, if set then update on that sales channel only | \n
| ProductID * | \nint | \nUnique Identifier for Product, optional but one of * other fields must be supplied | \n
| SKU * | \nString | \nStock Keeping Unit, optional but one of * other fields must be supplied | \n
| Barcode * | \nString | \nProduct Barcode, optional but one of * other fields must be supplied | \n
| SupplierSKU * | \nString | \nSupplier Stock Keeping Unit, optional but one of * other fields must be supplied | \n
| UpdateRealStock | \nBoolean | \nIf set to true then Actual Stock Level will be updated | \n
| StockQuantity | \nint | \nThe Quantity of Stock Units | \n
| UpdatePseudoStock | \nBoolean | \nIf set to true this will set Pseudostock Levels across the system | \n
| UpdatePseudoStockType | \nBoolean | \nIf set to true alters the PseudoStockLevelType | \n
| PseudoStockType | \nint | \nPseudoStockType ** | \n
| PseudoStockLevel | \nint | \nQuantity of Pseudostock | \n
| SupplierName | \nString | \nUsed in conjuction with SupplierSKU | \n
PseudoStockType
\n| PseudoStockType | \nValue | \nDetails | \n
|---|---|---|
| Off | \n0 | \nDo not use Pseudo Stock | \n
| Static | \n1 | \nStatic Psuedo Stock Number Regardless of Real Stock Levels i.e. always at 5 | \n
| DecrementUsePseudoStock | \n2 | \nDecrementing Psuedo Stock Number Regardless of Real Stock Levels i.e. 5-4-3-2-1-0 | \n
| DecrementUseAllStock | \n3 | \nDecrementing Psuedo Stock Number maintained by Real Stock Levels i.e. 5-5-5-5-4-3-2-1-0 - as long as real stock levels allow | \n
Managing Stock
\n","_postman_id":"99101e19-0244-450e-a267-80476de943fb"},{"name":"Customers","item":[{"name":"Search","id":"571bc325-7431-49f1-8048-80c3cf30ec15","request":{"method":"POST","header":[{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiCustomerService/Search"},{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"Searches Customer Records
\n","urlObject":{"path":["CCPApiCustomerService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"571bc325-7431-49f1-8048-80c3cf30ec15"},{"name":"GetCustomerById","id":"f05845f3-0271-4ba6-b610-7cd3cbfa32ed","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiCustomerService/GetCustomerById"}],"body":{"mode":"raw","raw":"NB. Do not pass null, for optional variables it is better to omit these from the SOAP Request as passing empty Nodes can cause serialization issues, see Introduction.
\n| Parameter | \nType | \nDetails | \n
|---|---|---|
| intBrandID | \nint32 | \nYour Brand ID | \n
| SalesChannelID | \nint32 | \nUnique Identifier for Selling Channel | \n
| CompanyName | \nstring | \nFull Customer Name or Company Name if Trade Customer | \n
| TradingName | \nstring | \nFull Customer Name or Trading Name if Trade Customer | \n
| FirstName | \nstring | \nFirst Name of Customer Contact | \n
| LastName | \nstring | \nSurname of Customer Contact | \n
| EmailAddress | \nstring | \nCustomer Email | \n
| intCustomerType | \nint32 | \nEnumerator - Acceptable values: 0 | default = 8 (Public) | 5 (Retailer) | \n
| intPaymentTerms | \nint32 | \nEnumerator - Acceptable Values : 0 | FullPaymentBeforeDespatch = 1 | DaysCredit28 = 2 | DaysCredit60 = 3 | \n FullPaymentWith10PercentEarlyPaymentDiscount = 4 | FiftyPercentUpfrontBalancein30Days = 5 | ThirtyPercentDepositBalanceOnDelivery = 6 | DirectDebit = 7 | DaysCredit30 = 8\n | \n
| VATNumber | \nstring | \nCustomer VAT Number | \n
| Address1 | \nstring | \nCustomer address line 1 | \n
| Address2 | \nstring | \ncustomer address line 2 | \n
| Postcode | \nstring | \nPostcode | \n
| TownCity | \nstring | \nTown / City | \n
| CountyRegion | \nstring | \nCounty Region | \n
| Country | \nstring | \nCountry | \n
| TelNo | \nstring | \nTelephone No | \n
| FaxNo | \nstring | \nFax | \n
| MobNo | \nstring | \nMobile | \n
| LoginID | \nint32 | \nN/A | \n
| AgentID | \nint32 | \nN/A | \n
| CreditLimit | \nsingle | \nN/A | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier for Customer Record | \n
| CustomerType | \nAPICustomerType | \nPublic = 8, Retailer = 5 | \n
| BrandID | \nint32 | \nUnique Identifier for your Brand | \n
| SalesChannelID | \nint32 | \nUnique identifier of customer sales channel | \n
| FirstName | \nstring | \nCustomer contact first name | \n
| LastName | \nstring | \nCustomer contact last name | \n
| EmailAddress | \nstring | \nEmail address | \n
| CompanyName | \nstring | \nFull Name of Customer or Company Name if Retailer | \n
| TradingName | \nstring | \nFull Name of Customer or Trading Name if Retailer | \n
| PaymentTerms | \nAPICustomerPaymentTerms | \n FullPaymentBeforeDespatch = 1, DaysCredit28 = 2, DaysCredit60 = 3, FullPaymentWith10PercentEarlyPaymentDiscount = 4, FiftyPercentUpfrontBalancein30Days = 5, ThirtyPercentDepositBalanceOnDelivery = 6, DirectDebit = 7, DaysCredit30 = 8 | \n
| TelNo | \nstring | \n\n |
| FaxNo | \nstring | \n\n |
| MobNo | \nstring | \n\n |
| Address1 | \nstring | \n\n |
| Address2 | \nstring | \n\n |
| TownCity | \nstring | \n\n |
| CountyRegion | \nstring | \n\n |
| Postcode | \nstring | \n\n |
| Country | \nstring | \n\n |
| LoginID | \nint32 | \n\n |
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier for Customer Record | \n
| CustomerType | \nAPICustomerType | \n\n |
| BrandID | \nint32 | \nUnique Identifier for your Brand | \n
| SalesChannelID | \nint32 | \nUnique identifier of customer sales channel | \n
| FirstName | \nstring | \nCustomer contact first name | \n
| LastName | \nstring | \nCustomer contact last name | \n
| EmailAddress | \nstring | \nEmail address | \n
| CompanyName | \nstring | \nFull Name of Customer or Company Name if Retailer | \n
| TradingName | \nstring | \nFull Name of Customer or Trading Name if Retailer | \n
| PaymentTerms | \nAPICustomerPaymentTerms | \n\n |
| TelNo | \nstring | \n\n |
| FaxNo | \nstring | \n\n |
| MobNo | \nstring | \n\n |
| Address1 | \nstring | \n\n |
| Address2 | \nstring | \n\n |
| TownCity | \nstring | \n\n |
| CountyRegion | \nstring | \n\n |
| Postcode | \nstring | \n\n |
| Country | \nstring | \n\n |
| LoginID | \nint32 | \n\n |
getActiveSalesChannels
\n","urlObject":{"path":["CCPApiSalesChannelService.svc"],"host":["{{localhost}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[],"_postman_id":"428d8c2d-b015-4939-80e3-5adb6539ddbf"},{"name":"getActiveSalesChannels LIVE","event":[{"listen":"test","script":{"id":"44d74988-c207-423a-893b-4b51d4fbb673","exec":["var responseJson = xml2Json(responseBody);","console.log('test response output here:');","console.log(responseJson);","console.log('response body here');","//console.log(responseJson['s:Envelope']['s:Body']);","console.log(JSON.stringify(responseJson['s:Envelope']['s:Body']['TestCredentialsResponse']['TestCredentialsResult']['Content']));","tests[\"Expected Content Value\"] = responseJson['s:Envelope']['s:Body']['TestCredentialsResponse']['TestCredentialsResult']['Content'] === \"true\";","","","","","",""],"type":"text/javascript"}}],"id":"463a69a7-07a7-4f53-ab0d-909d0b9630e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiSalesChannelService/getActiveSalesChannels"}],"body":{"mode":"raw","raw":"\r\ngetActiveSalesChannels
\n","urlObject":{"path":["CCPApiSalesChannelService.svc"],"host":["{{localhost}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[],"_postman_id":"463a69a7-07a7-4f53-ab0d-909d0b9630e0"},{"name":"getApiSalesChannels","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var responseJson = xml2Json(responseBody);","console.log('test response output here:');","console.log(responseJson);","console.log('response body here');","//console.log(responseJson['s:Envelope']['s:Body']);","console.log(JSON.stringify(responseJson['s:Envelope']['s:Body']['TestCredentialsResponse']['TestCredentialsResult']['Content']));","tests[\"Expected Content Value\"] = responseJson['s:Envelope']['s:Body']['TestCredentialsResponse']['TestCredentialsResult']['Content'] === \"true\";","","","","","",""]}}],"id":"9cb8f5d0-636c-4cf5-9eca-e5ae83578776","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiSalesChannelService/getApiSalesChannels"}],"body":{"mode":"raw","raw":"Gets Sales Data for a list of SKU's between a given date range.
\n","urlObject":{"path":["CCPApiSalesChannelService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"1defd6a9-b195-482b-865d-320470544986","name":"getSKUSalesReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiSalesChannelService/getSKUSalesReport"}],"body":{"mode":"raw","raw":"Retrieve information for product variations listed on a given sales channel.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| SalesChannelID | \nint | \nUnique Identifier for Sales Channel | \n
| Start | \nint | \nStart at record no x | \n
| End | \nint | \nEnd at record no y | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| Start | \nint | \nBegin at record no x | \n
| End | \nint | \nFinish at record no y | \n
| TotalCount | \nint | \nThe total no of products | \n
| TotalProductsInBrand | \nint | \nThe total no of products set up for your Brand | \n
| TotalProductsInSalesChannel | \nint | \nTotal no of products published on Sales Channel | \n
| products | \nAPIProduct[] | \nDetailed list of Products published on Sales Channel | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier of product | \n
| BrandID | \nint | \nUnique identifier for brand | \n
| Name | \nString | \nproduct variation name | \n
| Description | \nString | \nProduct variation description | \n
| ManufacturerSKU | \nString | \nStock keeping unit | \n
| DateAdded | \nDateTime | \nDate and time product added to CCP | \n
| SupplierProductLinks | \nAPIProductSupplierLink[] | \nList of suppliers and prices for this product | \n
| BasePrice | \nDecimal | \nThe default price | \n
| ChannelPrice | \nDecimal | \nSales channel specific price where provided | \n
| VATRateID | \nint | \nUnique identifier for tax rate | \n
| BarCodeNumber | \nString | \nBarcode number | \n
| AdditionalBarCodes | \nString | \nComma separated list of additional barcodes | \n
| ASIN | \nString | \nAamazon serial number | \n
| AmazonVariationID | \nint | \nUnique identifier for amazon variation | \n
| EbayListingID | \nString | \nUnique identifier for ebay listing | \n
| EbayVariationID | \nint | \nUnique identifier for ebay variation | \n
| ProductRangeID | \nint | \nUnique identifier for product range | \n
| PreOrder | \nBoolean | \nWhether the product can be pre-ordered | \n
| EndOfLine | \nBoolean | \nWhether this is the end of the line for this product | \n
| LengthMM | \nint | \nDimensions, length in millimeters | \n
| WidthMM | \nint | \nDimensions, width in millimeters | \n
| HeightMM | \nint | \nDimensions, height in millimeters | \n
| WeightGM | \nint | \nDimensions, weight in millimeters | \n
| LargeLetterCompatible | \nBoolean | \nWhether the product is compatible with being shipped as a large letter | \n
| ProductType | \nint | \n0 = Standard product 1 = Multipack | \n
| ProductVATRate | \nint | \nUnique identifier for product tax rate | \n
| SearchText | \nString | \nSearch phrases | \n
| StatusID | \nStatusID | \nStatus enumerator | \n
| AdditionalShippingLabel | \nBoolean | \nWhether this product has an additional shipping label | \n
| ExternalProductId | \nString | \nReference in external system e.g. Open Cart product id | \n
| Thumbs200x200 | \nString | \nFilename for thumbnail image | \n
| Thumbs75x75 | \nString | \nFilename for thumbnail image | \n
| MatchOptions | \nString | \n\n |
| StockLevel | \nint | \nThe number of units currently in stock | \n
| ChannelPseudoStockLevel | \nint | \nPseudostock level on sales channel when provided | \n
| SelectedProductRangeOptionValues | \nAPIProductRangeOptionValue[] | \nList of APIProductRangeOptionValue eg. size 7, colour blue, category men's trainers | \n
| imageB64Strings | \nString[] | \nArray of 64base strings representing images | \n
| images | \nAPIProductImage[] | \nList of images | \n
| AmazonVariations | \nAPIAmazonVariation] | \nList of amazon variations | \n
| EbayVariations | \n[APIEbayVariation] | \nList of ebay variatins | \n
| packItems | \nPackageProductWithQuantity[] | \nComponent part of pack product | \n
| SalesChannelLinks | \nAPISalesChannelLink[] | \nList of sales channel data for product inluding prices | \n
| PurchaseOrderMaxStock | \nint | \nMaximum amount of stock to order from suppliers | \n
| PurchaseOrderAtStockQuantity | \nint | \nStock level at which to create a new purhase order | \n
| PurchaseOrderStockType | \nint | \n\n |
| PurchaseOrderBoxQuantity | \nint | \n\n |
| ProductStockType | \nint | \n\n |
| DispatchIdentifierOption | \nint | \n\n |
| StockLocations | \nItemBayStockLevel[] | \nWarehouse bay locations of stock units | \n
| OnOrder | \nSupplierOrderItem[] | \nItems on order from suppliers | \n
Managing Selling Channels
\n","_postman_id":"30075647-e7f7-4d4b-b3d3-973db675017b"},{"name":"Orders","item":[{"name":"GetUnallocatedOrders","id":"48356454-9c53-4e4d-ac12-7c26f8ac6504","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiOrderService/getUnallocatedOrders"}],"body":{"mode":"raw","raw":"get unallocated orders
\n","urlObject":{"path":["CCPApiOrderService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"48356454-9c53-4e4d-ac12-7c26f8ac6504"},{"name":"GetOrderDetailsById","id":"44812c81-205c-4548-9415-9bf76aaa2a0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiOrderService/getOrderDetailsById"}],"body":{"mode":"raw","raw":"getOrderById
\n","urlObject":{"path":["CCPApiOrderService.svc"],"host":["{{live}}"],"query":[{"key":"wsdl","value":null}],"variable":[]}},"response":[],"_postman_id":"f7c0b525-de75-4207-9e54-b129a7cd6ad3"},{"name":"getOrdersForDispatch","id":"53aa4f3b-c07c-493c-b801-d9cfd2e32b5c","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiOrderService/getOrdersForDispatch"}],"body":{"mode":"raw","raw":"Search Orders
\n| Property | \nType | \nDetails | \n
|---|---|---|
| BrandID | \nint | \nUnique Identifier for Brand | \n
| StartDate | \nDateTime | \nDate from which to begin query | \n
| EndDate | \nDateTime | \nDate to end query | \n
| Skip | \nint | \nNo of records to skip in paged recordset. Optiional, default is 0 | \n
| Take | \nint | \nNo of records to take from paged recordset, optional default is 200 | \n
| SalesChannelID | \nint | \nUnique identifier for Sales Channel | \n
| CustomerOrderStatusTypes | \nCustomerOrderStatusType[] | \nOptional. Defaults to \"Created\" see list below | \n
| ready | \n* DEPRECATED | \n
| picked | \nThe order has been picked | \n
| picking | \nThe order is in the process of being picked | \n
| packed | \nThe order has been packed | \n
| packing | \nThe order is in the process of being packed | \n
| shipped | \nThe order has been shipped | \n
| partiallyshipped | \nThe order has been partially shipped\" | \n
| dropshipdetected | \nThis order can be dropshipped | \n
| dropshipemailsent | \nThis order has been emailed to the supplier | \n
| advanceddropshipemailsent | \nThis order has been emailed to the supplier | \n
| DeliveryAddressChange | \nThe order DeliveryAddressID has changed | \n
| BillingAddressChange | \nThe order BillingAddressID has changed | \n
| ShippingRuleChange | \nThe order ShippingRule has changed | \n
| StatusDescriptionChange | \nThe order status description has changed | \n
| DispatchDateChange | \nThe order DispatchDate has changed\" | \n
| Paid | \nThe order Paid state has changed | \n
| Created | \nThe order has been created | \n
| Edited | \nThe order has been edited | \n
| Unallocated | \nThe order has been unallocated\" | \n
| Cancelled | \nhe order has been cancelled | \n
| Allocated | \nThe order has been allocated | \n
| Returned | \nThis order has been returned | \n
| Ignored | \nThis order has been ignored | \n
| Refunded | \nThis order has been refunded | \n
Querying Orders
\n| Property | \nType | \nDetails | \n
|---|---|---|
| intBrandID | \nInt32 | \nYour Brand ID | \n
| dtFilter | \nDateTime | \nDate to begin querying orders from in Y-m-d format | \n
| strCustType | \nString | \n\"0\" Trade and Retail Customers (Default), \"1\" Trade Customer Orders Only, \"2\" Retail Customers Only | \n
| strPriority | \nString | \nFilter Orders by their Status. Possible Values: Priority | Exported | \n
| strOrderType | \nString | \n\"0\" Undispatched Orders , \"1\" Dispatched Orders | \n
| numberofdays | \nInt32 | \nOrder Dispatched x up to x No of Days ago | \n
| showUnallocated | \nBoolean | \nWhether to include Unallocated Orders in the Result | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nInt32 | \nUnique Identifier | \n
| OrderReceivedDate | \nString | \nDate Order entered into CCP System | \n
| OrderDispatchedDate | \nString | \nDate of Order Dispatch | \n
| Customer | \nString | \nObject | \n
| Status | \nString | \n\n |
| DropshipDetected | \nBoolean | \nWhether or not the order is to be dropshipped | \n
| DropshipSuppliers | \nDropShipSupplier[] | \nList of Dropship Suppliers for ordered products | \n
| items | \nAPIOrderItem[] | \nList of Items Ordered | \n
Dispatches a Customer Order
\n| Property | \nType | \nDetails | \n
|---|---|---|
| OrderId | \nint | \nUnique Identifier for Customer Order | \n
| DispatchOptions | \nccpApiDispatchOptions | \nObject | \n
| DispatchType | \nccpApiDispatchType | \nEnumerator | \n
| ConsignmentReferenceNumber | \nString | \nCourier consignment number | \n
| TrackingNumber | \nString | \nCourier tracking number | \n
Get a list of Shipping Rules
\n","urlObject":{"path":["CCPApiOrderService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"82d1727a-5069-40d9-ab0d-de8e8da9ed02"}],"id":"56224583-c839-4ba3-94d9-657c9c41620e","description":"Managing Dispatch
\n","_postman_id":"56224583-c839-4ba3-94d9-657c9c41620e"},{"name":"Returns","item":[{"name":"GetOutstandingReturns","id":"59cf9a7d-fb34-46ff-a337-fcf38eed326b","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICcpApiOrderReturnsService/GetOutstandingReturns"}],"body":{"mode":"raw","raw":"Retreives a list of Bank Accounts
\n","urlObject":{"path":["CCPApiPaymentService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"80a9946a-9591-4b10-b862-c2eb108575ee"},{"name":"CreatePayment","id":"1d934336-2638-46fa-aaef-2dd70916dafc","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiPaymentService/CreatePayment"}],"body":{"mode":"raw","raw":"Creates a Payment Transaction for a given Invoice and Allocates the amount paid.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| intBrandID | \nint | \nUnique Identifier for Brand | \n
| intSalesChannelID | \nint | \nUnique Identifier for Sales Channel | \n
| intBankAccountID | \nint | \nUnique Identifier for Bank Details | \n
| strPaymentReference | \nString | \nPayee Reference | \n
| dbPaymentNetAmount | \nDouble | \nFull Amount of Payment | \n
| dbPaymentTaxAmount | \nDouble | \nN/A | \n
| dbPaymentAmount | \nDouble | \nFull Amount of Payment | \n
| dbGBPPaymentAmount | \nDouble | \nFull Amount of Payment in GBP | \n
| dbPostagePaymentAmount | \nDouble | \nN/A | \n
| dbPostageGBPPaymentAmount | \nDouble | \nN/A | \n
| dtPaymentDate | \nDateTime | \nTransaction Date | \n
| TransactionTypeID | \nTransactionTypeID | \nUnique Identifier for Transaction Type | \n
| intCustomerID | \nint | \nUnique Identifier for Customer | \n
| GatewayType | \nPaymentGatewayType | \nUnique Identifier for Payment Gateway | \n
None = 0,\n PayPal = 1,\n SagePay = 2,\n Stripe = 17
\nCash = 21,\n CardPayment = 12,\n ChequePayment = 13,\n StandingOrder = 14,\n DirectDebit = 15,\n BACS = 16,\n OnlineBankingTransfer = 18,\n CreditNote = 11,\n Invoice = 9,\n PaymentGateway = 19
\nThe Content returned in the Response is the Unique Identifier for the Payment Transaction.
\n","urlObject":{"path":["CCPApiPaymentService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[],"_postman_id":"1d934336-2638-46fa-aaef-2dd70916dafc"},{"name":"TestCredentials","id":"b1d92f9c-c862-41d3-8e75-7c5c91f2dfb7","request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiPaymentService/TestCredentials"}],"body":{"mode":"raw","raw":"Method for setting AccountingPrimaryReference and AccountingSecondaryReference fields on Transactions.
\nRequest content is a List of TransactionWrapper Objects.
\n","urlObject":{"path":["CcpApiTransactionService.svc"],"host":["{{localhost}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"abcdb117-795c-41af-867d-8fc174d2fa3e","name":"LogTransactions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","type":"text"},{"key":"SOAPAction","value":"http://tempuri.org/ICcpApiTransactionService/LogTransactions","type":"text"}],"body":{"mode":"raw","raw":"Query Financial Transactions
\n| Property | \nType | \nDetails | \n
|---|---|---|
| StartDate | \nDateTime | \nDate to begin the query from | \n
| EndDate | \nDateTime | \nDate to end query | \n
| includeProcessedTransactions | \nBoolean | \nIf set to false then any transactions which your external system has marked as having a AccountingPrimaryReference and AccountingSecondaryReference value will not be returned in the result. | \n
| transactionTypes | \nTransactionType[] | \n* See below for possible values. If ommitted from the request then all transaction types will be returned | \n
\n
| TransactionType | \n* Details | \n
|---|---|
| SalesInvoice | \nRepresents a Sales Invoice | \n
| SalesCredit | \nRepresents a Sales Credit Note | \n
| SalesReceipt | \nRepresents a Payment received from a Customer | \n
| SalesPayment | \nRepresents a Refund Paid to a Customer | \n
| SalesAllocation | \nRepresents the Allocation of a Credit Transaction against a Debit Transaction | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| TotalRecordsAvailable | \nint | \nThe total no of records available | \n
| transactions | \nTransactionWrapper[] | \nThe List of Transactions in the result | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| Date | \nDateTime | \nDate of Transaction | \n
| CustomerID | \nInt32 | \nUnique ID of Customer | \n
| SageAccountRef | \nString | \nSage Account Ref of Customer | \n
| CustomerName | \nString | \nFull Customer Name | \n
| SalesInvoice | \nSalesInvoice | \nObject | \n
| SalesCreditNote | \nSalesCreditNote | \nObject | \n
| SalesReceipt | \nSalesReceipt | \nObject | \n
| SalesPayment | \nSalesPayment | \nObject | \n
| SalesAllocation | \nSalesAllocation | \nObject | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nInt32 | \nUnique Identifier | \n
| Date | \nDateTime | \nInvoice Date | \n
| CustomerID | \nInt32 | \nUnique Identifier for Customer | \n
| SageAccountRef | \nString | \nCustomer Sage Account Ref | \n
| CustomerName | \nString | \nFull Customer Name | \n
| transactionType | \nTransactionType | \nSalesInvoice | \n
| SalesChannelID | \nInt32 | \nUnique Identifier for Selling Channel | \n
| SalesChannel | \nString | \nName of Sales Channel e.g. Amazon UK | \n
| BankNominal | \nString | \nBank Account Code in Sage or Other Accounts Software | \n
| SalesNominal | \nString | \nSales Ledger Nominal Code | \n
| CarriageNominal | \nString | \nPostage and Packaging Income Nominal Code | \n
| CarriageNet | \nDecimal | \nCarriage Charges excluding Tax | \n
| CarriageVat | \nDecimal | \nTax on Carriage Charge | \n
| Carriage | \nDecimal | \nCarriage Charge | \n
| NetAmount | \nDecimal | \nNet Amount of Invoice Excluding Carriage | \n
| VatAmount | \nDecimal | \nTotal Tax on Goods | \n
| Amount | \nDecimal | \nFull Invoice Amount | \n
| LineItems | \ncnSageInvoiceItem.SageInvoiceItem[] | \nDetailed breakdown of Invoice Line Items | \n
| CurrencyCode | \nString | \nCurrency of Transaction | \n
| AccountingPrimaryReference | \nString | \nIdentifier for Invoice in External Accounting Software | \n
| AccountingSecondaryReference | \nString | \nIdentifier for Customer in External Accounting Software | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nInt32 | \nUnique Identifier for Credit Note | \n
| Date | \nDateTime | \nCredit Note Date | \n
| CustomerID | \nInt32 | \nUnique Identifier for Customer | \n
| SageAccountRef | \nString | \nSage Account Ref | \n
| CustomerName | \nString | \nFull Customer Name | \n
| transactionType | \nTransactionType | \nSalesCreditNote | \n
| SalesChannelID | \nInt32 | \nUnique Identifier for Selling Channel | \n
| SalesChannel | \nString | \nSales Channel Name | \n
| BankNominal | \nString | \nNominal Code for Bank Account | \n
| SalesNominal | \nString | \nSales Ledger Nominal Code | \n
| CarriageNominal | \nString | \nNominal Code for Post and Packing Income | \n
| CarriageNet | \nDecimal | \nCarriage exclusive of Tax | \n
| CarriageVat | \nDecimal | \nTax on Carriage | \n
| Carriage | \nDecimal | \nCarriage inclusive of Tax | \n
| NetAmount | \nDecimal | \nFull Net Amount for Goods | \n
| VatAmount | \nDecimal | \nFull Tax Amount for Goods | \n
| Amount | \nDecimal | \nFull Credit Note Amount | \n
| LineItems | \nccpPaymentItem.PaymentItem | \nCredit Note Line Items | \n
| Allocations | \ncnSageAllocation.SageAllocation | \nDebits the Credit Note has been allocated against | \n
| CurrencyCode | \nString | \nCredit Note Currency | \n
| AccountingPrimaryReference | \nString | \nIdentifier for Credit Note in External Accounting Software | \n
| AccountingSecondaryReference | \nString | \nIdentifier for Customer in External Accounting Software | \n
Money received from a Customer.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nInt32 | \nUnique Identifier for Payment | \n
| Date | \nDateTime | \nTransaction Date | \n
| CustomerID | \nInt32 | \nUnique Identifier for Customer | \n
| SageAccountRef | \nString | \nSage Account Reference | \n
| CustomerName | \nString | \nFull Customer Name | \n
| transactionType | \nTransactionType | \nSalesReceipt | \n
| SalesChannelID | \nInt32 | \nUnique Identifier for Selling Channel | \n
| SalesChannel | \nString | \nSales Channel Name | \n
| BankNominal | \nString | \nNominal Code for Bank Account | \n
| SalesNominal | \nString | \nN/A | \n
| CarriageNominal | \nString | \nN/A | \n
| CarriageNet | \nDecimal | \nN/A | \n
| CarriageVat | \nDecimal | \nN/A | \n
| Carriage | \nDecimal | \nN/A | \n
| NetAmount | \nDecimal | \nN/A | \n
| VatAmount | \nDecimal | \nN/A | \n
| Amount | \nDecimal | \nN/A | \n
| Allocations | \ncnSageAllocation.SageAllocation | \nThe Transactions this Receipt has been allocated against | \n
| CurrencyCode | \nString | \nCurrency of Receipt | \n
| AccountingPrimaryReference | \nString | \nIdentifier for Receipt in External Accounting Software | \n
| AccountingSecondaryReference | \nString | \nIdentifier for Customer in External Accounting Software | \n
Represents money refunded to a customer.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nInt32 | \nUnique Identifier for Transaction | \n
| Date | \nDateTime | \nTransaction Date | \n
| CustomerID | \nInt32 | \nUnique Identifier for Customer | \n
| SageAccountRef | \nString | \nSage Account Ref for Customer | \n
| CustomerName | \nString | \nFull Customer Name | \n
| transactionType | \nTransactionType | \nSalesPayment | \n
| SalesChannelID | \nInt32 | \nUnique Identifier for Selling Channel | \n
| SalesChannel | \nString | \nSales Channel Name | \n
| BankNominal | \nString | \nNominal Code for Bank Account | \n
| SalesNominal | \nString | \nN/A | \n
| CarriageNominal | \nString | \nN/A | \n
| CarriageNet | \nDecimal | \nN/A | \n
| CarriageVat | \nDecimal | \nN/A | \n
| Carriage | \nDecimal | \nN/A | \n
| NetAmount | \nDecimal | \nPayment Amount | \n
| VatAmount | \nDecimal | \nN/A | \n
| Amount | \nDecimal | \nPayment Amount | \n
| CurrencyCode | \nString | \nPayment Currency | \n
| AccountingPrimaryReference | \nString | \nIdentifier for Refund in External Accounting Software | \n
| AccountingSecondaryReference | \nString | \nIdentifier for Customer in External Accounting Software | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique identifier for Allocation | \n
| Date | \nDateTime | \nDate of Allocation | \n
| CustomerID | \nint | \nUnique identifier for Customer | \n
| OrderID | \nint | \nUnique identifier for Order this relates to | \n
| Amount | \nDecimal | \nThe amount being allocated | \n
| SageAccountRef | \nString | \nThe Sage or Xero Account Ref for the Customer | \n
| CustomerName | \nString | \nFull Customer name | \n
| transactionType | \nTransactionType | \nSalesAllocation | \n
| SalesChannelID | \nint | \nUnique identifier for selling channel | \n
| SalesChannel | \nString | \nName of sales channel | \n
| BankNominal | \nString | \nThe Nominal Code for the Bank Account | \n
| SalesNominal | \nString | \nThe Sales Ledger Nominal Code | \n
| AccountingPrimaryReference | \nString | \nPrimary Reference in External Accounting Software | \n
| AccountingSecondaryReference | \nString | \nSecondary Reference in External Accounting Software | \n
| SalesInvoice | \nSalesInvoice | \nSalesInvoice | \n
| SalesReceipt | \nSalesReceipt | \nSalesReceipt | \n
| SalesCreditNote | \nSalesCreditNote | \nSalesCreditNote | \n
| SalesPayment | \nSalesPayment | \nSalesPayment | \n
| CurrencyCode | \nString | \nCurrency Transactions are in | \n
| BrandID | \n | Your unique identifier in CCP | \n |
| Security Hash | \n | Your api key | \n |
| APICustomerAddCustomerRequest | \n | Object | \n |
NB. Do not pass null, for optional variables it is better to omit these from the SOAP Request as passing empty Nodes can cause serialization issues, see Introduction.
\n| Parameter | \nType | \nDetails | \n
|---|---|---|
| intBrandID | \nint32 | \nYour Brand ID | \n
| SalesChannelID | \nint32 | \nUnique Identifier for Selling Channel | \n
| CompanyName | \nstring | \nFull Customer Name or Company Name if Trade Customer | \n
| TradingName | \nstring | \nFull Customer Name or Trading Name if Trade Customer | \n
| FirstName | \nstring | \nFirst Name of Customer Contact | \n
| LastName | \nstring | \nSurname of Customer Contact | \n
| EmailAddress | \nstring | \nCustomer Email | \n
| intCustomerType | \nint32 | \nEnumerator - Acceptable values: 0 | default = 8 (Public) | 5 (Retailer) | \n
| intPaymentTerms | \nint32 | \nEnumerator - Acceptable Values : 0 | FullPaymentBeforeDespatch = 1 | DaysCredit28 = 2 | DaysCredit60 = 3 | \n FullPaymentWith10PercentEarlyPaymentDiscount = 4 | FiftyPercentUpfrontBalancein30Days = 5 | ThirtyPercentDepositBalanceOnDelivery = 6 | DirectDebit = 7 | DaysCredit30 = 8\n | \n
| VATNumber | \nstring | \nCustomer VAT Number | \n
| Address1 | \nstring | \nCustomer address line 1 | \n
| Address2 | \nstring | \ncustomer address line 2 | \n
| Postcode | \nstring | \nPostcode | \n
| TownCity | \nstring | \nTown / City | \n
| CountyRegion | \nstring | \nCounty Region | \n
| Country | \nstring | \nCountry | \n
| TelNo | \nstring | \nTelephone No | \n
| FaxNo | \nstring | \nFax | \n
| MobNo | \nstring | \nMobile | \n
| LoginID | \nint32 | \nN/A | \n
| AgentID | \nint32 | \nN/A | \n
| CreditLimit | \nsingle | \nN/A | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier for Customer Record | \n
| CustomerType | \nAPICustomerType | \nPublic = 8, Retailer = 5 | \n
| BrandID | \nint32 | \nUnique Identifier for your Brand | \n
| SalesChannelID | \nint32 | \nUnique identifier of customer sales channel | \n
| FirstName | \nstring | \nCustomer contact first name | \n
| LastName | \nstring | \nCustomer contact last name | \n
| EmailAddress | \nstring | \nEmail address | \n
| CompanyName | \nstring | \nFull Name of Customer or Company Name if Retailer | \n
| TradingName | \nstring | \nFull Name of Customer or Trading Name if Retailer | \n
| PaymentTerms | \nAPICustomerPaymentTerms | \n FullPaymentBeforeDespatch = 1, DaysCredit28 = 2, DaysCredit60 = 3, FullPaymentWith10PercentEarlyPaymentDiscount = 4, FiftyPercentUpfrontBalancein30Days = 5, ThirtyPercentDepositBalanceOnDelivery = 6, DirectDebit = 7, DaysCredit30 = 8 | \n
| TelNo | \nstring | \n\n |
| FaxNo | \nstring | \n\n |
| MobNo | \nstring | \n\n |
| Address1 | \nstring | \n\n |
| Address2 | \nstring | \n\n |
| TownCity | \nstring | \n\n |
| CountyRegion | \nstring | \n\n |
| Postcode | \nstring | \n\n |
| Country | \nstring | \n\n |
| LoginID | \nint32 | \n\n |
Creates an Order on CCP but returns a much more detailed response than the Create Order method.
\n| Parameter | \nType | \nDetails | \n
|---|---|---|
| nCustomerID | \nint | \nUnique Identifier of customer record | \n
| intBrandID | \nint | \nUnique Identifier of Brand | \n
| nSeasonID | \nint | \n\n |
| nLoginID | \nint | \n\n |
| nOrderID | \nint | \n\n |
| nSendEmail | \nint | \n1 = true 0 = false | \n
| strReference | \nstring | \nOrder Reference | \n
| nPaymentTermID | \nint | \n\n |
| strDeliveryDate | \nDateTime | \nDate Order to be delivered - defaults to current date | \n
| ShipByDate | \nDateTime | \nDeadline for shipping date - defaults to current date | \n
| strPostageOverride | \nstring | \n\n |
| NetCarriage | \nDecimal | \nCarriage before tax | \n
| VATCarriage | \nDecimal | \nTax on carriage | \n
| decCarriageTotal | \nDecimal | \nCarriage charge | \n
| intAddByLoginID | \nint | \n\n |
| intPaymentStatus | \nint | \n\n0 = Allow Dispatch without Payment\n-1 = Paid\n1 = Unpaid\n | \n
| intDaysOfCredit | \nint | \n\n |
| doTriggers | \nBoolean | \nSpecifies whether to set off system configured triggers, for example send email to customer | \n
| ShippingService | \nstring | \nThe name of the shipping service to be used | \n
| ShippingRuleID | \nint | \nUnique Identifier for the Shipping Rule, defaults to manual | \n
| ExternalReference | \nstring | \nExternal Sytem Reference | \n
| Note | \nstring | \nNote | \n
| BillingAddress | \nAPIOrderBillingAddress | \n\n |
| ShippingAddress | \nAPIOrderShippingAddress | \n\n |
| orderItems | \nAPIOrderItem[] | \n\n |
| Parameter | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier for Order Line Item | \n
| OrderID | \nint | \nUnique Identifier for Order | \n
| BarCode | \nstring | \nMain barcode of product | \n
| SKU | \nstring | \nStock Keeping Unit | \n
| ExternalProductId | \nstring | \nUnique Identifier in External System | \n
| AdditionalBarCodes | \nstring | \nComma separated list of additional barcodes | \n
| ProductID | \nint | \nUnique Identifier of Product | \n
| ProductName | \nstring | \n\n |
| VatRateID | \nint | \nUnique Identifier for Tax Rate | \n
| Quantity | \nint | \nNo of Items | \n
| UseNetPrice | \nBoolean | \nIf set to true then price per unit excludes tax | \n
| DiscountCalculatedInPrice | \nBoolean | \n\n |
| RowTotalNet | \nDecimal | \nTotal of Line Item before discount and not including Tax | \n
| RowTotalVAT | \nDecimal | \nTotal tax on line item minus tax on discount | \n
| Price | \nDecimal | \nPrice per unit | \n
| Discount | \nDecimal | \nDiscount per unit | \n
| RowDiscountGross | \nDecimal | \nCalculated discount including tax on line item | \n
| RowDiscountNet | \nDecimal | \nCalculated discount excluding tax on line item | \n
| RowDiscountVAT | \nDecimal | \nTax component of discount | \n
| RowTotalGross | \nDecimal | \nCalculated total of Line Item | \n
| Parameter | \nType | \nDetails | \n
|---|---|---|
| ShippingAddressCompanyName | \nstring | \nCompany Name of Shpping Address | \n
| ShippingContactFirstName | \nstring | \nFirst Name of Delivery Contact | \n
| ShippingContactLastName | \nstring | \nSurname of Delivery Contact | \n
| ShippingTelephone | \nstring | \n\n |
| ShippingMobile | \nstring | \n\n |
| ShippingAddress1 | \nstring | \nBuilding Name or Number of Delivery Address | \n
| ShippingAddress2 | \nstring | \nStreet Name | \n
| ShippingTown | \nstring | \n\n |
| ShippingCounty | \nstring | \n\n |
| ShippingPostCode | \nstring | \n\n |
| ShippingCountry | \nstring | \n\n |
| Parameter | \nType | \nDetails | \n
|---|---|---|
| BillingAddressCompanyName | \nstring | \nCompany Name of Billing Address | \n
| BillingContactFirstName | \nstring | \nFirst Name of Billing Contact | \n
| BillingContactLastName | \nstring | \nBilling Contact Surname | \n
| BillingTelephone | \nstring | \n\n |
| BillingMobile | \nstring | \n\n |
| BillingAddress1 | \nstring | \nBuilding Number or Name | \n
| BillingAddress2 | \nstring | \n\n |
| BillingTown | \nstring | \n\n |
| BillingCounty | \nstring | \n\n |
| BillingPostCode | \nstring | \n\n |
| BillingCountry | \nstring | \n\n |
| Property | \nType | \nDetails | \n
|---|---|---|
| customer | \ncnCustomer.Customer | \nCustomer Details | \n
| APIOrderItems | \nccpCustomerOrderItem[] | \nOrder Line Items | \n
| order | \ncnCustomerOrder.CustomerOrder | \nOrder Details | \n
| CourierSelection | \nccpBrandCourierSelection.BrandCourierSelection | \nCourier Details | \n
| CourierServiceRule | \nccpCourierServicesRules.CourierServicesRules | \nCourier Service Rule | \n
| Country | \nccpCountry.Country | \nCountry | \n
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier of Customer | \n
| CompanyName | \nString | \nCompany Name of Customer or Full Name if Retail | \n
| TradingName | \nString | \nTrading Name of Customer or Full Name if Retail | \n
| VATNumber | \nString | \nVAT Registration Number of Customer | \n
| SageVATCode | \nint | \n\n |
| CreditLimit | \nDecimal | \nCustomer Credit Limit | \n
| String | \n\n | |
| AgentID | \nint | \n\n |
| SageAccountID | \nString | \nSage / Xero Account Ref | \n
| SageStatus | \nint | \n\n |
| SalesChannelID | \nint | \nUnique Identifier for Customer Sales Channel | \n
| PaymentTermID | \nint | \n\n |
| BarCodeGenerator | \nint | \n\n |
| LoginID | \nint | \n\n |
| BrandID | \nint | \nUnique Brand Identifier | \n
| ParentID | \nint | \n\n |
| SystemStatus | \nString | \n\n |
| Type | \nint | \n\n |
| EcomID | \nint | \n\n |
| SpecialDeliveryInstructions | \nint | \n\n |
| SpecDelInstrNote | \nString | \n\n |
| OnWatchList | \nint | \n\n |
| WatchListReason | \nString | \n\n |
| StatusID | \nint | \n\n |
| QuickBooksId | \nString | \n\n |
| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier of Order | \n
| PartOrderID | \nint | \n\n |
| EcomOrderID | \nint | \n\n |
| BrandID | \nint | \nUnique Identifier of Brand | \n
| SalesChannelID | \nint | \nUnique Identifier of Sales Channel | \n
| SalesChannelType | \nEnumerator | \nThe Type of Sales Channel | \n
| IsFBA | \nint | \n1 = FBA , 0 = Non FBA | \n
| SeasonID | \nint | \nUnique Identifier for Season | \n
| CustomerID | \nint | \nUnique Identifier for Customer | \n
| Date | \nDateTime | \nDate order placed | \n
| CreationDate | \nDateTime | \nDate of Order | \n
| HideUntilDate | \nDateTime | \n\n |
| ShipByDate | \nDateTime | \n\n |
| IsExported | \nint | \n1 = true 0 = false | \n
| CountryID | \nint | \nUnique Identifier of Country | \n
| CurrencyCode | \nstring | \nThree letter ISO Currency Code | \n
| ExchangeRate | \ndecimal | \n\n |
| ExportedDate | \nDateTime | \n\n |
| DeliveryDate | \nDateTime | \nDate order Delivered | \n
| DispatchDate | \nDateTime | \nDate order Dispatched | \n
| Reference | \nstring | \norder reference | \n
| ExternalOrderRef | \nstring | \nexternal system reference | \n
| ExternalOrderType | \nint | \n\n |
| Note | \nstring | \n\n |
| Priority | \nboolean | \n\n |
| StatusDescription | \nstring | \nStatus of order: Allocated, Cancelled, Completed, Ignored, Pending, Unallocated | \n
| OrderType | \nint | \n\n |
| BillingAddressID | \nint | \nUnique identifier for billing address | \n
| DeliveryAddressID | \nint | \nUnique identifier for delivery address | \n
| DeliveryAddress | \nDeliveryAddress | \n\n |
| CourierType | \nint | \nUnique Identifier of Courier Type | \n
| ShippingType | \nint | \nUnique Identifier of Shipping Type | \n
| PreDispatchTrackingNumber | \nstring | \n\n |
| PreDispatchTrackingUrl | \nstring | \n\n |
| DefaultCSRuleID | \nint | \n\n |
| DefaultCSRuleCost | \ndecimal | \n\n |
| DefaultCSRuleCostGBP | \ndecimal | \n\n |
| DefaultBCSID | \nint | \n\n |
| ShippingServiceName | \nstring | \n\n |
| IsInternational | \nboolean | \n\n |
| GroupedOrder | \nboolean | \n\n |
| PickTicketSent | \nboolean | \n\n |
| PickListPrinted | \nbool | \n\n |
| PickStatus | \nint | \n\n |
| LockPickUntil | \nDateTime | \n\n |
| AssignedToWarehouseId | \nint | \nUnique identifier of warehouse | \n
| BarCodeReader | \nint | \n\n |
| TotalFactoryCost | \ndecimal | \n\n |
| TotalFactoryCostGBP | \ndecimal | \n\n |
| TotalExtraCost | \ndecimal | \n\n |
| TotalExtraCostGBP | \ndecimal | \n\n |
| TotalCost | \ndecimal | \n\n |
| TotalCostGBP | \ndecimal | \n\n |
| TotalProfit | \ndecimal | \n\n |
| TotalProfitGBP | \ndecimal | \n\n |
| ExtraCostsNet | \ndecimal | \n\n |
| ExtraCostsVat | \ndecimal | \n\n |
| ExtraCostsGross | \ndecimal | \n\n |
| ExpectedTotalGross | \ndecimal | \n\n |
| TotalRowNetBeforeDiscount | \ndecimal | \n\n |
| TotalRowVatBeforeDiscount | \ndecimal | \n\n |
| TotalRowGrossBeforeDiscount | \ndecimal | \n\n |
| TotalOrderDiscountGross | \ndecimal | \n\n |
| TotalOrderDiscountNet | \ndecimal | \n\n |
| TotalOrderDiscountVat | \ndecimal | \n\n |
| TotalItemDiscountNet | \ndecimal | \n\n |
| TotalItemDiscountVat | \ndecimal | \n\n |
| TotalItemDiscountGross | \ndecimal | \n\n |
| ItemValue | \ndecimal | \n\n |
| PostageNet | \ndecimal | \nShipping charge excluding tax | \n
| PostageNetGBP | \ndecimal | \n\n |
| PostageVAT | \ndecimal | \nTax on shipping | \n
| PostageVATGBP | \ndecimal | \n\n |
| Postage | \ndecimal | \nShipping charge | \n
| PostageValue | \ndecimal | \n\n |
| GBPPost | \ndecimal | \n\n |
| DiscountNet | \ndecimal | \n\n |
| DiscountNetGBP | \ndecimal | \n\n |
| DiscountVAT | \ndecimal | \n\n |
| DiscountVATGBP | \ndecimal | \n\n |
| DiscountGross | \ndecimal | \n\n |
| DiscountGrossGBP | \ndecimal | \n\n |
| TotalNet | \ndecimal | \nThe total value of the goods less discount and excluding shipping | \n
| TotalNetGBP | \ndecimal | \n\n |
| TotalVAT | \ndecimal | \nThe total tax on the goods | \n
| TotalVATGBP | \ndecimal | \n\n |
| TotalGross | \ndecimal | \n\n |
| TotalGrossGBP | \ndecimal | \n\n |
| TotalValue | \ndecimal | \nTotal monetary value of order | \n
| Payment | \nint | \nUnique Identifier of Payment | \n
| StatusID | \nint | \n\n |
| StatusIDEnum | \nEnumerator | \n\n |
| LoyaltyPayment | \ndecimal | \n\n |
| LoyaltyPointsAvailable | \nint | \n\n |
| LoyaltyPointsSpent | \nint | \n\n |
| LoyaltyPointsEarned | \nint | \n\n |
Obtain Invoice Details to Pay for Order
\nSimply pass in the OrderID
\n| Property | \nType | \nDetails | \n
|---|---|---|
| ID | \nint | \nUnique Identifier for Invoice Record | \n
| ProformaID | \nint | \nUnique Identifier for Proforma Relating to Invoice | \n
| BrandID | \nint | \nUnique Identifier for Brand | \n
| SalesChannelID | \nint | \nUnique Identifier for Sales Channel | \n
| InvoiceDate | \nDateTime | \nInvoice Date | \n
| CustomerID | \nint | \nUnique Identifier for Customer | \n
| NetAmount | \nDecimal | \nCalculated net amount of Invoice | \n
| VATAmount | \nDecimal | \nCalculated tax amount of Invoice | \n
| Amount | \nDecimal | \nCalculated gross amount of Invoice | \n
| AmountPaid | \nDecimal | \nAmount Paid | \n
Creates a Payment Transaction for a given Invoice and Allocates the amount paid.
\n| Property | \nType | \nDetails | \n
|---|---|---|
| intBrandID | \nint | \nUnique Identifier for Brand | \n
| intSalesChannelID | \nint | \nUnique Identifier for Sales Channel | \n
| intBankAccountID | \nint | \nUnique Identifier for Bank Details | \n
| strPaymentReference | \nString | \nPayee Reference | \n
| dbPaymentNetAmount | \nDouble | \nFull Amount of Payment | \n
| dbPaymentTaxAmount | \nDouble | \nN/A | \n
| dbPaymentAmount | \nDouble | \nFull Amount of Payment | \n
| dbGBPPaymentAmount | \nDouble | \nFull Amount of Payment in GBP | \n
| dbPostagePaymentAmount | \nDouble | \nN/A | \n
| dbPostageGBPPaymentAmount | \nDouble | \nN/A | \n
| dtPaymentDate | \nDateTime | \nTransaction Date | \n
| TransactionTypeID | \nTransactionTypeID | \nUnique Identifier for Transaction Type | \n
| intCustomerID | \nint | \nUnique Identifier for Customer | \n
| GatewayType | \nPaymentGatewayType | \nUnique Identifier for Payment Gateway | \n
None = 0,\n PayPal = 1,\n SagePay = 2,\n Stripe = 17
\nCash = 21,\n CardPayment = 12,\n ChequePayment = 13,\n StandingOrder = 14,\n DirectDebit = 15,\n BACS = 16,\n OnlineBankingTransfer = 18,\n CreditNote = 11,\n Invoice = 9,\n PaymentGateway = 19
\nThe Content returned in the Response is the Unique Identifier for the Payment Transaction.
\n","urlObject":{"path":["CCPApiPaymentService.svc"],"host":["{{baseUrl}}"],"query":[{"key":"wsdl","value":""}],"variable":[]}},"response":[{"id":"e4178c42-3e53-4483-9456-c5b11756563d","name":"Create Payment (Pay Invoice for Order)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"},{"key":"SOAPAction","value":"http://tempuri.org/ICCPApiPaymentService/CreatePayment"}],"body":{"mode":"raw","raw":"Dispatches a Customer Order
\n| Property | \nType | \nDetails | \n
|---|---|---|
| OrderId | \nint | \nUnique Identifier for Customer Order | \n
| DispatchOptions | \nccpApiDispatchOptions | \nObject | \n
| DispatchType | \nccpApiDispatchType | \nEnumerator | \n
| ConsignmentReferenceNumber | \nString | \nCourier consignment number | \n
| TrackingNumber | \nString | \nCourier tracking number | \n
Create a New Product Variation
\nBasic request for adding a Product Variation
\n| Property | \nType | \nDetails | \n
|---|---|---|
| BrandID | \nint | \nUnique identifier for Brand | \n
| ProductRangeID | \nint | \nUnique identifier for Product Range | \n
| Name | \nstring | \nProduct Name | \n
| Description | \nstring | \nProduct description | \n
| ManufacturerSKU | \nstring | \nStock Keeping Unit | \n
| DateAdded | \ndatetime | \nDate record created | \n
| VATRateID | \nint | \nUnique identifier for Product Default Tax Rate | \n
| BasePrice | \ndecimal | \nDefault selling price | \n
| ProductType | \nint | \nPass default value of 0 | \n
In this section you will find instructions on how to perform some basic tasks via the CCP API.
\n","_postman_id":"d637f547-1bc5-43ac-afb5-2fc2eab5d367"}],"event":[{"listen":"prerequest","script":{"id":"f81aa0a8-9be0-4ca5-be84-50bef5b8b922","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03f5fd2c-1031-443e-a5e4-e44ce1d76163","type":"text/javascript","exec":[""]}}]}