registerDeliveries | CPP Help Center

UpdateOrdersResponse registerDeliveries( 
 	CPAuth auth,  	CPDelivery[] deliveries  
);

PHP-Codesnippets and samples for this function can be found here.

Input

Parameter	Type	Optional	Comment
auth	CPAuth	no	Authentication data
deliveries	CPDelivery[]	no	A list of deliveries. Maximum of 100 per request!

Output

Method returns a UpdateOrdersResponse

Description

With this call you register your deliveries with Channel Pilot Pro. A delivery can be a full or partial delivery. If you have multiple partial deliveries, Channel Pilot Pro will automatically complete the delivery when the last item is delivered.

Fields

For a complete delivery (every item sent in one delivery), set the CPDelivery.orderHeader and set isDeliveryCompleted to true.

Examples (SOAP-UI)

Full delivery

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
	<soapenv:Header/>
	<soapenv:Body>
		<v4:registerDeliveries>
			<auth>
				<merchantId>xxxxxxxxxx</merchantId>
				<shopToken>xxxxxxxxxx</shopToken>
			</auth>
			<deliveries>
				<item>
					<orderHeader>
						<orderId>12345678</orderId>
						<orderIdExternal>TEST_ORDER_531_3</orderIdExternal>
						<source>ebay.de</source>
					</orderHeader>
					<deliveryTime>2019-02-06T14:00:00+02:00</deliveryTime>
					<carrierName>DHL</carrierName>
					<isDeliveryCompleted>true</isDeliveryCompleted>
					<trackingNumber>2304230423402384092384</trackingNumber>
					<returnTrackingNumber>3314531393402384092495</returnTrackingNumber>
				</item>
			</deliveries>
		</v4:registerDeliveries>
	</soapenv:Body>
</soapenv:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns1:registerDeliveriesResponse xmlns:ns1="http://v4_2.seller.api.channelpilot.com/">
			<return>
				<header>
					<resultCode>200</resultCode>
					<resultMessage/>
				</header>
				<updateResults>
					<header>
						<resultCode>200</resultCode>
						<resultMessage/>
					</header>
					<orderHeader>
						<orderId>12345678</orderId>
						<orderIdExternal>TEST_ORDER_531_3</orderIdExternal>
						<source>ebay.de</source>
						<status>
							<identifier>30</identifier>
							<publicTitle>Versandt</publicTitle>
							<publicDescription>Bestellung wurde versandt</publicDescription>
							<hasError>false</hasError>
						</status>
						<orderTime>2019-02-07T13:42:30+01:00</orderTime>
						<isBusinessOrder>false</isBusinessOrder>
					</orderHeader>
				</updateResults>
			</return>
		</ns1:registerDeliveriesResponse>
	</soap:Body>
</soap:Envelope>

Partial delivery

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://v4_2.seller.api.channelpilot.com/">
	<soapenv:Header/>
	<soapenv:Body>
		<v4:registerDeliveries>
			<auth>
				<merchantId>xxxxxxxxxx</merchantId>
				<shopToken>xxxxxxxxxxxxxxxxxxxxxxxxxx</shopToken>
			</auth>
			<deliveries>
				<item>
					<orderHeader>
						<orderId>50863</orderId>
						<orderIdExternal>TEST_ORDER_533_207</orderIdExternal>
						<source>amazon.de</source>
					</orderHeader>
					<deliveryTime>2019-02-06T14:00:00+02:00</deliveryTime>
					<carrierName>DHL</carrierName>
					<trackingNumber>2304230423402384092384</trackingNumber>
					<returnTrackingNumber>3314531393402384092495</returnTrackingNumber>
					<isDeliveryCompleted>false</isDeliveryCompleted>
					<deliveredItems>
						<id>2522</id>
						<idExternal>TEST_ORDER_533_207_ITEM_1</idExternal>
						<quantityOrdered>2</quantityOrdered>
						<quantityDelivered>1</quantityDelivered>
						<quantityCancelled>0</quantityCancelled>
					</deliveredItems>
				</item>
			</deliveries>
		</v4:registerDeliveries>
	</soapenv:Body>
</soapenv:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns1:registerDeliveriesResponse xmlns:ns1="http://v4_2.seller.api.channelpilot.com/">
			<return>
				<header>
					<resultCode>200</resultCode>
					<resultMessage/>
				</header>
				<updateResults>
					<header>
						<resultCode>200</resultCode>
						<resultMessage/>
					</header>
					<orderHeader>
						<orderId>50863</orderId>
						<orderIdExternal>TEST_ORDER_533_207</orderIdExternal>
						<source>amazon.de</source>
						<status>
							<identifier>25</identifier>
							<publicTitle>Teilweise Ausgeliefert</publicTitle>
							<publicDescription>Die Bestellung wurde teilweise ausgeliefert. Möglicherweise wurde ein Teil auch bereits storniert</publicDescription>
							<hasError>false</hasError>
						</status>
						<orderTime>2019-02-07T13:42:30+01:00</orderTime>
						<isBusinessOrder>false</isBusinessOrder>
					</orderHeader>
				</updateResults>
			</return>
		</ns1:registerDeliveriesResponse>
	</soap:Body>
</soap:Envelope>