| Input | Output |
R | Required parameter; cannot be null | The returned value for this variable will never be null. |
O | Optional parameter, may be considered | The returned value for this variable can be null. |
- | The parameter is not considered in method | The variable is not returned by this method. |
CPAddress
Type
| Name
| (out) all requests | Description
| Sample Data
|
Int | genderId | R | 1 for male, 2 for female, -1 for unknown/default. Channel Pilot Pro will try to determine genderId if not provided by the channel. | 1 |
String | nameFirst | R | First name | “John“ |
String | nameLast | R | Last name | “Doe“ |
String | nameFull | R | Full name | “John Doe“ |
String | company | O | Company | “Sample ltd.“ |
String | streetTitle | R | Name of street | “Samplestreet“ |
String | streetNumber | R | Street number | “3a“ |
String | streetFull | R | Full street (name and number) | “Samplestreet 3a“ |
String | streetExtra | O | Additional data for address | “co. other name“ |
String | city | R | Name of city | “SomeCity“ |
String | state | R | State | “Hessen”, “Iowa” |
String | zip | R | Zip code of city | “1234 E” |
String | countryIso2 | R | ISO2 code of country | DE |
String | countryIso3 | R | ISO3 code of country | DEU |
String | phone | O | Phone of customer | “+4344533345” |
CPArticle
Type
| Name
| (out) all requests | Description
| Sample Data
|
String | id | R | (Your) articleId that you have mapped as “unique article number” in Channel Pilot Pro. | “12323/42E” |
String | idExternal | O | Id of the article provided by channel. | “00045045” |
String | title | O | Title of the article. | “My Article“ |
String | ean | O | European Article Number | „8595570102077“ |
CPAuth
Type
| Name
| (in) all requests | Description
| Sample Data
|
String | merchantId | R | Your merchantId. This identifies the Channel Pilot-Account you are addressing. |
|
String | shopToken | R | Your shopToken. This identifies the Channel Pilot-shop you are addressing. |
|
CPCancellations
Type
| Name
| registerCancellations | Description
| Sample Data
|
CPOrderHeader | orderHeader | R | The header of the order required to identify your order. |
|
String | cancellationTime | R | The time of the cancellation (see, 5.2). | “2015-05-15T12:01:04+02:00“ |
Boolean | isWholeOrderCancelled | R | False if only some of the articles are cancelled. | 1 = true / 0 = false |
CPOrderItem[] | cancelledItems | R* | Required if isWholeOrderCancelled == false. Optional otherwise. |
|
CPRefund
Type
| Name
| registerRefunds | Description
| Sample Data
|
CPOrderHeader | orderHeader | R | The header of the order required to identify your order. |
|
String | refundTime | R | The time of the refund (see, 5.2). | “2015-05-15T12:01:04+02:00“ |
CPMoney | refund | R | The amount of the refund. |
|
String | refundReason | O | The reason for the refund. | “delayed shipment” |
CPCustomer
Type
| Name
| (out) all requests | Description
| Sample Data
|
String | idExternal | R | ID of the customer on the marketplace. | “3423424234232” |
int | genderId | R | 1 for male, 2 for female, -1 for unknown/default. Channel Pilot Pro will try to determine genderId if not provided by the channel. | 0 |
CPCustomerGroup[] | customerGroups | R | Can be empty if you did not provide customer groups for this marketplace. |
|
String | nameFirst | R | First name | “John“ |
String | nameLast | R | Last name | “Doe“ |
String | nameFull | R | Full name | “John Doe“ |
String | R | Email of the customer. Some marketplaces provide “forward-mails” that are only valid for email-forwarding through the marketplace and not for direct communication (e.g. Amazon). | “Sample ltd.“ | |
String | phone | O | Phone number | “445345345” |
String | mobile | O | Mobile phone number | “+4315135234“ |
String | fax | O | Fax number | “23424234234“ |
String | vat |
| VAT number | DE2834379 |
String | siret |
| The SIRET number | 78746532534573 |
CPCustomerGroup
A customer can be a member of zero or more customer groups. Customer groups are created automatically if you use our shop plugins and map to the customer groups of your shop. But you can create/add/remove more customer groups if required.
Type
| Name
| (out) all requests | Description
| Sample Data
|
String | id | R | Your ID of the mapped customerGroup. This ID should map to an ID in your Shop- or ERP-system. | “group_amazon” |
String | title | R | Title of the customer group. | “Amazon customers” |
CPDelivery
The CPDelivery holds information about a delivery and is only used in the method registerDeliveries
Type
| Name
| (in) registerDeliveries | Description
| Sample Data
|
CPOrderHeader | orderHeader | R | The orderHeader, necessary to identify your order. |
|
String | deliveryTime | R | The time of the delivery (see, 5.2). | “2015-05-15T12:01:04+02:00“ |
String | carrierName | O | Name of carrier for this delivery. | “DHL”, “UPS” |
Boolean | isDeliveryCompleted | R | Set to true if all items are delivered or false if only some articles are. | true |
String | trackingNumber | O | The trackingnumber of the shipment. | “234234234234234234” |
String | returnTrackingNumber | O | The return trackingnumber of the shipment. | “134134134134134134” |
CPShipping | shipping | O | If you set the shipment.typeId, Channel Pilot Pro will register this delivery with another shipping-service than stored in CPOrder.CPShipping. | “my_shipmnt_srvce_id_xy” |
CPOrderItem[] | deliveredItems | O | If you set isDeliveryCompleted to false, you will have to provide the delivered items. |
|
CPManagedArticlePrice
Type
| Name
| (out) getDynamicArticlePrices | Description
| Sample Data
|
CPArticle | article | R | The article for this price-info. |
|
Number | price | R | The actual price. | 23.03 |
String | lastUpdate | R | The date this price was updated the last time (see, 5.2). | “2015-05-15T12:01:04+02:00“ |
CPMoney
Type
| Name
| (out) all requests | Description
| Sample Data
|
Number | net | R | The net-price. | 100.00 |
Number | gross | R | The gross-price. | 119.00 |
Numer | tax | R | Tax included in gross. | 19.00 |
Number | taxRate | R | The taxrate of tax included in gross. | 19.00 |
CPOrder
Type
| Name
| (out) getNewMarketplaceOrders | (in) setImportedOrders | (in) setPaidOrders | Description
| Sample Data
|
CPOrderHeader | orderHeader | R | R | R | Header of the order (contains meta information). |
|
CPCustomer | customer | R |
|
| The customer’s data. |
|
CPAddress | addressInvoice | R |
|
| The invoice address (also set if it is the same as the delivery address). |
|
CPAddress | addressDelivery | R |
|
| The delivery address. |
|
CPOrderItem[] | itemsOrdered | R | O |
| The ordered items. |
|
CPShipping | shipping | R |
|
| Shipping information. |
|
CPPayment | payment | R |
| R | Payment information. |
|
CPOrderSummary | summary | R |
|
| Summary for this order. |
|
CPMoney | discount | R |
|
| Discount for this order. |
|
String | expectedShippingTimeFrom | R |
|
| Expected shipping time for this order. |
|
String | expectedShippingTimeTo | R |
|
|
|
|
CPOrderItem
Type
| Name
| (out) getNewMarketplaceOrders | (in) setImportedOrders | (in) registerDeliveries | (in) registerCancellations | Description
| Sample Data
|
String | id | -* | O** | R*** | R*** | * Not returned, because not available at this time. It will only be available after a setImportedOrders-call (if you provided the ID in this call). ** You have to provide the id if you want to it by a unique ID from your Shop- or ERP-system for this item. *** One of the parameters is required to identify the correct orderItem. Channel Pilot Pro will use the following order to attempt to identify the correct orderItem: id, idExternal, article. | “123” |
String | idExternal | R | O* | * You have to provide the external ID if you want to set the id by a unique ID from your Shop- or ERP- sytem for this item. | “sdAdd3” |
|
|
CPArticle | article | R | - | The article bought by customer. |
|
|
|
Int | quantityOrdered | R | - | - | - | The quantity of items ordered. | 2 |
Int | quantityDelivered | R | - | - | - | The quantity of already delivered items. | 0 |
Int | quantityCancelled | R | - | - | - | The quantity of already cancelled items. | 0 |
CPMoney | costsSingle | R | - | - | - | The costs of a single article. |
|
CPMoney | costsTotal | R | - | - | - | The costs of all the articles in this orderItem. |
|
Number | feeSingleNet | R | - | - | - | The marketplace-fee for a single article. | 22.50 |
Number | feeTotalNet | R | - | - | - | The marketplace-fee for all articles in this orderItem. | 45.00 |
CPMoney | discount | R | - | - | - | Discount for this order. |
|
CPMoney | discountSingle | R | - | - | - | Discount for a single Item |
|
String | expectedShippingTimeFrom | R |
|
|
| Expected shipping time for this order. |
|
String | expectedShippingTimeTo | R |
|
|
|
|
|
String | marketPlaceSpecificData | - | - | - | - | Marketplace Specific Data | „Otto“ |
Boolean | taxCollectionByMarketplace | R | - | - | - | In case, of available special tax collection by the marketplace, this value is set to true. If not, this value will be false. It can be empty, too | „true“ / „false“ or empty |
CPOrderHeader
Type
| Name
| (out) getNewMarketplaceOrders | (out) default | (in) setImportedOrders | (in) setPaidOrders | (in) registerDeliveries | (in) registerCancellations | Description
| Sample Data
|
String | orderId | - |
| R* | R | R | R | * orderId will be saved and will be sent to the marketplace if the function is provided by marketplace. | “443535” |
String | orderIdExternal | R |
| R* | - | - | - | The external order ID, provided by the marketplace. * Necessary to identify the order, because orderId is not yet known. | “11231231- 1231312312” |
String | orderIdExternalT ransactionId | O |
|
|
|
|
| The external order transaction ID is a ebay specific field and is provided by the marketplace. | “121124971073- 1094989827002” |
String | source | R |
| R* | - | - | - | The source(-id) of the marketplace that the order was generated by. * Necessary to identify the order, because orderId is not yet known. | “ebay.de” |
CPOrderStatus | status | R |
| R* | - | - | - | The status or the order. * Method will check if status.hasError is true and saves status.errorCode and status.errroMessage. |
|
String | orderTime | R |
| - | - | - | - | Date of order (see, 5.2). |
|
String | purchaseOrderNumber | - |
| - | - | - | - | The B2B-Customer internal order number | „12121324“ |
boolean | isBusinessOrder | O |
| - | - | - | - | Flag for marking an order as business order | true/false |
String | marketPlaceSpecificData | O | - | - | - | - | - | Marketplace Specific Data | „Otto“ |
CPOrderStatus
Type
| Name
| (out) all requests | (in) setImportedOrders | (in) default | Description
| Sample Data
|
String | identifier | R | - | - | Unique identifier for the orderStatus. | “10” |
String | publicTitle | R | - | - | A (translated) title for this status. | “ready for import” |
String | publicDescription | R | - | - | A (translated) description for this status. | “order is ready to be imported into Shop- or ERP-system” |
boolean | hasError | R | R | - | True, if a processing error has occurred in some step. | false |
Integer | errorCode | O | O* | - | Error code appears if error occurred. * Your custom error code will be stored if you provide it. | 700 |
String | errorMessage | O | O* | - | Error message if error occurred. * Your custom error message will be stored if you provide it. | “payment method is unknown” |
Possible CPOrderStatus identifier
Identifier
| Value
|
10 | Ready to import |
20 | Imported |
30 | Shipped |
99 | Cancelled |
25 | Partially Delivered |
CPOrderSummary
Type
| Name
| (out) all requests | (in) all requests | Description
| Sample Data
|
CPMoney | totalSumItems | R | - | The total costs of all orderItems combined. |
|
CPMoney | totalSumOrder | R | - | The total costs of the whole order (including delivery costs etc.). |
|
String | message | O | - | A message that the customer provided to you. | “please ship fast :D” |
Number | feeTotalNet | R | - | The total net-fee you have to pay to the marketplace. | 45.00 |
String | currencyIso3 | R | - | ISO3 currency code for this order. | “EUR” |
CPPagination
This object is currently not used but may be introduced in a future release!
CPPayment
Type
| Name
| (out) all requests | (in) setPaidOrders | (in) default | Description
| Sample Data
|
String | typeId | R | - | - | The ID (your ID) of your mapped paymenttype. | “marketplaces” |
String | typeTitle | R | - | - | The title of your mapped payment-type. | “payment type for marketplace orders” |
CPMoney | costs | R | - | - | Costs of payment (e.g., surcharge for creditcard payment). |
|
String | paymentTime | R | R | - | Date of payment (see, 5.2). | “2015-05-15T12:01:04+02:00“ |
CPResponseHeader
Type
| Name
| (out) all requests | Description
| Sample Data
|
int | resultCode | R | The result code for the call (see, 4.1). | 200 |
String | resultMessage | R | A result message (can be empty). | “” |
CPShipping
Type
| Name
| (out) all requests | (in) registerDeliveries | (in) default | Description
| Sample Data
|
String | typeId | R | O* | - | The ID (your ID) of your mapped delivery-type. * You can set a different delivery-method during this call if you want to. You have to set a typeId if the shipment is not null during this call! | “dhl_std” |
String | typeTitle | R | - | - | The title of your mapped delivery-type. | “DHL stardard delivery” |
CPMoney | costs | R | - | - | Costs of delivery (e.g., surcharge for 24h delivery). |
|
GetDynamicArticlePricesResponse
Type
| Name
| (out) getDynamicArticlePrices | Description
| Sample Data
|
CPResponseHeader | header | R | Header with information about the call. |
|
Boolean | moreAvailable | R | True, if there are more (newer) prices to be processed than returned in this call. | true |
Int | countMoreAvailable | R | The amount of newer prices to be processed than returned in this call. | 4535 |
CPManagedArticlePrice[] | managedArticlePrices | R | A list of price-data. Each entry belongs to one article. |
|
GetNewMarketplaceOrdersResponse
Type
| Name
| (out) getNewMarketplaceOrders | Description
| Sample Data
|
CPResponseHeader | header | R | Header with information about the call. |
|
boolean | moreAvailable | R | True if there are more marketplace orders to process than returned in this call. | true |
int | countMoreAvailable | R | The amount of other marketplace orders to be processed than returned in this call. | 23 |
CPOrder[] | orders | R | The list of returned marketplace orders. |
|
GetServerTimeResponse
Type
| Name
| (out) getServerTime | Description
| Sample Data
|
CPResponseHeader | header | R | Header with information about the call. |
|
String | localTime | R | The current server time (see, 5.2). | “2015-05-15T12:01:04+02:00“ |
UpdateOrdersResponse
Type
| Name
| (out) all requests | Description
| Sample Data
|
CPResponseHeader | header | R | Header with information about the call. |
|
UpdateOrderResult[] | updateResults | R | A list of updateResults. Each update has one updateResult. Can be empty if the complete call failed. Inspect the header first! |
|
UpdateOrderResult
Type
| Name
| (out) all requests | Description
| Sample Data
|
CPResponseHeader | header | R | Header with information about this update. |
|
CPOrderHeader | orderHeader | R | The orderHeader to identify the order in your system. |
|