Orders API Version 3 WSDL

 

Operations

Get Orders by Shipping Number

Get Orders by Order Number 

Get Orders by Date and Status

Create Orders

Batch Information

Please note:

It is your responsibility to properly set up all translation features, perform testing, and request support from ShipEdge in a timely manner. It is your responsibility to test and verify the integration between ShipEdge and any 3rd party selling channel. We strongly recommend frequent testing of any integration, specially when changes occur on your selling channel (e.g. SKU renaming, shipping method variations, permissions and credentials). ShipEdge is not responsible for translation issues, omitted orders, or any other issues related to communication with any 3rd party selling channel. Support for channel automation requires at least 24 hours for investigation before any action can be taken (hourly development charges may apply). The warehouse is not responsible for any omission, duplication or error in your orders coming through this system, and you agree not to get the warehouse involved in integration issues, nor will they make any exception or procedure changes due to the use of this feature.

BASE API  http://integration.shipedge.com/API/Orders_3/OrderAPI.php?wsdl  

Example PHP: ClientOrderAPI.php

 

(*) means required data.

access

Paremeter

Type

Description

AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
Example
<access xsi_type="tns:access">
<AccountID xsi_type="xsd:int">210</AccountID>
<Key xsi_type="xsd:string">xxxxxx</Key>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>

Get Order by Shipping Numbers

Gets the collection of orders. – Returns Orders in your account, along with the values for each attribute in each on (metadata).

Method: ordersAccount
orderList

Paremeter      

Type

Description

itemvarcharSpecify a list of SHIPPING NUMBER to get details about orders. 
Example
<orderList SOAP-ENC:arrayType="xsd:string[2]" xsi_type="SOAP-ENC:Array">
<item xsi_type="xsd:string">196514</item>
<item xsi_type="xsd:string">165451</item>
</orderList>

 

Request

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"     >
<SOAP-ENV:Body>
<tns:ordersAccount >
<access xsi_type="tns:access">
<AccountID xsi_type="xsd:int">210</AccountID>
<Key xsi_type="xsd:string">xxxxxxxxxx</Key>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>
<orderList SOAP-ENC:arrayType="xsd:string[2]" xsi_type="SOAP-ENC:Array">
<item xsi_type="xsd:string">196514</item>
<item xsi_type="xsd:string">165451</item>
</orderList>
</tns:ordersAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<SOAP-ENV:Envelope     >
<SOAP-ENV:Body>
<ns1:ordersAccountResponse >
<requestOrders xsi_type="tns:ordersResponse">
<access xsi_type="tns:accessResponse">
<AccountID xsi_type="xsd:int">210</AccountID>
<AccessAccount xsi_type="xsd:string">Allow: ordersAccount</AccessAccount>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>
<ordersResp SOAP-ENC:arrayType="tns:orderArray[2]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:orderArray">
<ShippingNum xsi_type="xsd:string">196508</ShippingNum>
<OrderNum xsi_type="xsd:string">5119558_cp_C_cp_shipedge_NC2_cp</OrderNum>
<orderRef xsi_type="xsd:string"/>
<orderShipCarrier xsi_type="xsd:string">Fedex</orderShipCarrier>
<orderShipMethod xsi_type="xsd:string">FINTFRT</orderShipMethod>
<TrackingNum xsi_type="xsd:string">794617133411</TrackingNum>
<ActualWeight xsi_type="xsd:string">0.5</ActualWeight>
<OrderDate xsi_type="xsd:string">2014-10-02 16:44:31</OrderDate>
<ShipDate xsi_type="xsd:string">2014-10-03 22:33:57</ShipDate>
<custEmail xsi_type="xsd:string">nils.flores@gmail.com</custEmail>
<custFName xsi_type="xsd:string">Jorge</custFName>
<custLName xsi_type="xsd:string">Rodrigues</custLName>
<custCompany xsi_nil="true" xsi_type="xsd:string"/>
<custState xsi_type="xsd:string">Derbyshire</custState>
<custCity xsi_type="xsd:string">derby</custCity>
<custZip xsi_type="xsd:string">DE23 8GG</custZip>
<custCountry xsi_type="xsd:string">United Kingdom</custCountry>
<custAddress1 xsi_type="xsd:string">53 wilfred street</custAddress1>
<custAddress2 xsi_type="xsd:string"/>
<custAddress3 xsi_type="xsd:string"/>
<billFName xsi_type="xsd:string">Jorge</billFName>
<billLName xsi_type="xsd:string">Rodrigues</billLName>
<billCompany xsi_type="xsd:string"/>
<billState xsi_type="xsd:string">Derbyshire</billState>
<billCity xsi_type="xsd:string">derby</billCity>
<billZip xsi_type="xsd:string">DE23 8GG</billZip>
<billCountry xsi_type="xsd:string">United Kingdom</billCountry>
<billAddress1 xsi_type="xsd:string">53 wilfred street</billAddress1>
<billAddress2 xsi_type="xsd:string"/>
<billAddress3 xsi_type="xsd:string"/>
<Residential xsi_type="xsd:string">NO</Residential>
<RequireSignature xsi_type="xsd:string">NO</RequireSignature>
<Priority xsi_nil="true" xsi_type="xsd:string"/>
<Note xsi_type="xsd:string"/>
<Status xsi_type="xsd:string">SHIPPED</Status>
<new_order_numbers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[0]"/>
<new_shipping_numbers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[0]"/>
<Items xsi_type="xsd:string">1</Items>
<HoldReleaseDate xsi_nil="true" xsi_type="xsd:string"/>
<Detaill SOAP-ENC:arrayType="tns:DetaillSku[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:DetaillSku">
<Sku xsi_type="xsd:string">s15-10</Sku>
<Qty xsi_type="xsd:string">1</Qty>
<SoldPrice xsi_type="xsd:string">0.00</SoldPrice>
<Description xsi_type="xsd:string"/>
<Currency xsi_type="xsd:string">USD</Currency>
<new_order_number xsi:type="xsd:string"/>
<new_shipping_number xsi:type="xsd:string"/>
</item>
</Detaill>
<DetaillCost xsi_nil="true" xsi_type="tns:DetaillCost"/>
</item></ordersResp>
</requestOrders>
</ns1:ordersAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Get Orders by Order Numbers

Gets the collection of orders. – Returns Orders in your account, along with the values for each attribute in each on (metadata).

Method: ordersNumAccount
orderList

Paremeter      

Type

Description

itemvarcharSpecify a list of ORDER NUMBER to get details about orders. 
Example
<orderList SOAP-ENC:arrayType="xsd:string[2]" xsi_type="SOAP-ENC:Array">
<item xsi_type="xsd:string">1221595500011_2</item>
<item xsi_type="xsd:string">196508</item>
</orderList>

Request

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"     >
<SOAP-ENV:Body>
<tns:ordersNumAccount >
<access xsi_type="tns:access">
<AccountID xsi_type="xsd:int">210</AccountID>
<Key xsi_type="xsd:string">xxxxxxxx</Key>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>
<orderList SOAP-ENC:arrayType="xsd:string[2]" xsi_type="SOAP-ENC:Array">
<item xsi_type="xsd:string">1221595500011_2</item>
<item xsi_type="xsd:string">196508</item>
</orderList>
</tns:ordersNumAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<SOAP-ENV:Envelope     >
<SOAP-ENV:Body>
<ns1:ordersNumAccountResponse >
<requestOrders xsi_type="tns:ordersResponse">
<access xsi_type="tns:accessResponse">
<AccountID xsi_type="xsd:int">210</AccountID>
<AccessAccount xsi_type="xsd:string">Allow: ordersNumAccount</AccessAccount>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>
<ordersResp SOAP-ENC:arrayType="tns:orderArray[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:orderArray">
<ShippingNum xsi_type="xsd:string">196524</ShippingNum>
<OrderNum xsi_type="xsd:string">1221595500011_2</OrderNum>
<orderRef xsi_type="xsd:string">120829931834</orderRef>
<orderShipCarrier xsi_type="xsd:string"/>
<orderShipMethod xsi_type="xsd:string"/>
<TrackingNum xsi_nil="true" xsi_type="xsd:string"/>
<ActualWeight xsi_type="xsd:string">0.2</ActualWeight>
<OrderDate xsi_type="xsd:string">2014-11-05 13:02:48</OrderDate>
<ShipDate xsi_nil="true" xsi_type="xsd:string"/>
<custEmail xsi_type="xsd:string">nvnjrq36wv4y03x@marketplace.amazon.com</custEmail>
<custFName xsi_type="xsd:string">Aydee</custFName>
<custLName xsi_type="xsd:string">Elizondo martinez</custLName>
<custCompany xsi_nil="true" xsi_type="xsd:string"/>
<custState xsi_type="xsd:string">Monterrey</custState>
<custCity xsi_type="xsd:string">Monterrey</custCity>
<custZip xsi_type="xsd:string">64700</custZip>
<custCountry xsi_type="xsd:string">Mexico</custCountry>
<custAddress1 xsi_type="xsd:string">Rio Aguanaval 2206 local 3 Col. Roma</custAddress1>
<custAddress2 xsi_type="xsd:string"/>
<custAddress3 xsi_type="xsd:string"/>
<billFName xsi_type="xsd:string">Aydee</billFName>
<billLName xsi_type="xsd:string">Elizondo martinez</billLName>
<billCompany xsi_type="xsd:string"/>
<billState xsi_type="xsd:string">Monterrey</billState>
<billCity xsi_type="xsd:string">Monterrey</billCity>
<billZip xsi_type="xsd:string">64700</billZip>
<billCountry xsi_type="xsd:string">Mexico</billCountry>
<billAddress1 xsi_type="xsd:string">Rio Aguanaval 2206 local 3 Col. Roma</billAddress1>
<billAddress2 xsi_type="xsd:string"/>
<billAddress3 xsi_type="xsd:string"/>
<Residential xsi_type="xsd:string"/>
<RequireSignature xsi_type="xsd:string"/>
<Priority xsi_nil="true" xsi_type="xsd:string"/>
<Note xsi_type="xsd:string"/>
<Status xsi_type="xsd:string">PROCESSING</Status>
<new_order_numbers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[0]"/>
<new_shipping_numbers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[0]"/>
<Items xsi_type="xsd:string">1</Items>
<HoldReleaseDate xsi_nil="true" xsi_type="xsd:string"/>
<Detaill SOAP-ENC:arrayType="tns:DetaillSku[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:DetaillSku">
<Sku xsi_type="xsd:string">PHI/F-9308-900-0</Sku>
<Qty xsi_type="xsd:string">1</Qty>
<SoldPrice xsi_type="xsd:string">0.00</SoldPrice>
<Description xsi_type="xsd:string"/>
<Currency xsi_type="xsd:string">USD</Currency>
<new_order_number xsi:type="xsd:string"/>
<new_shipping_number xsi:type="xsd:string"/>
</item>
</Detaill>
<DetaillCost xsi_nil="true" xsi_type="tns:DetaillCost"/>
</item>
</ordersResp></requestOrders>
</ns1:ordersNumAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Get Order by Order Date and Status

Gets the collection of orders. – Returns Orders in your account, along with the values for each attribute in each on (metadata).

Method: ordersDateStatusAccount
dateList

Paremeter      

Type

Description

dateBeginvarcharStart date searchar, format YYYY-MM-DD
dateEndvarcharEnd date searchar, format YYYY-MM-DD
StatusvarcharStatus orders to find, if empty return all orders, status type: SHIPPED, CANCEL, PROCESSING, PENDING, DIVIDED
PagevarcharThat can be inputted from 1 to ‘n’ number of pages, ‘N’ being the total number of pages that the query has.
Included a new field for the API response ‘[Page] => 1 of 50 pages’ which indicates at which page you are at and how many pages there are total.
Example
<dateList xsi_type="tns:dateStatusList">
<dateBegin xsi_type="xsd:string">2014-10-15</dateBegin>
<dateEnd xsi_type="xsd:string">2014-10-15</dateEnd>
<Status xsi_type="xsd:string">SHIPPED</Status>
<Page xsi_type="xsd:string">1</Page>

Request

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"     >
<SOAP-ENV:Body>
<tns:ordersDateStatusAccount >
<access xsi_type="tns:access">
<AccountID xsi_type="xsd:int">210</AccountID>
<Key xsi_type="xsd:string">xxxx</Key>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>
<dateList xsi_type="tns:dateStatusList">
<dateBegin xsi_type="xsd:string">2014-09-15</dateBegin>
<dateEnd xsi_type="xsd:string">2014-10-15</dateEnd>
<Status xsi_type="xsd:string">SHIPPED</Status>
<Page xsi_type="xsd:string">1</Page>
</dateList>
</tns:ordersDateStatusAccount></SOAP-ENV:Body></SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope     >
<SOAP-ENV:Body>
<ns1:ordersDateStatusAccountResponse >
<requestOrders xsi_type="tns:ordersResponse">
<access xsi_type="tns:accessResponse">
<AccountID xsi_type="xsd:int">210</AccountID>
<AccessAccount xsi_type="xsd:string">Allow: ordersDateStatusAccount&lt;br&gt;</AccessAccount>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
<Page xsi_type="xsd:string">1 of 55 pages</Page>
</access>
<ordersResp SOAP-ENC:arrayType="tns:orderArray[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:orderArray">
<ShippingNum xsi_type="xsd:string">196500</ShippingNum>
<OrderNum xsi_type="xsd:string">463211_test_dont_ship_cp1</OrderNum>
<orderRef xsi_type="xsd:string"/>
<orderShipCarrier xsi_type="xsd:string">USPS</orderShipCarrier>
<orderShipMethod xsi_type="xsd:string">FCD</orderShipMethod>
<TrackingNum xsi_type="xsd:string">9400111969000940000011</TrackingNum>
<ActualWeight xsi_type="xsd:string">0.2</ActualWeight>
<OrderDate xsi_type="xsd:string">2014-09-15 21:17:50</OrderDate>
<ShipDate xsi_type="xsd:string">2014-10-06 03:44:41</ShipDate>
<custEmail xsi_type="xsd:string"/>
<custFName xsi_type="xsd:string">Frank</custFName>
<custLName xsi_type="xsd:string">Weil</custLName>
<custCompany xsi_nil="true" xsi_type="xsd:string"/>
<custState xsi_type="xsd:string">NY</custState>
<custCity xsi_type="xsd:string">NEW YORK</custCity>
<custZip xsi_type="xsd:string">10012-2623</custZip>
<custCountry xsi_type="xsd:string">United States</custCountry>
<custAddress1 xsi_type="xsd:string">636 BROADWAY</custAddress1>
<custAddress2 xsi_type="xsd:string">RM 516</custAddress2>
<custAddress3 xsi_type="xsd:string"/>
<billFName xsi_type="xsd:string">Frank</billFName>
<billLName xsi_type="xsd:string">Weil</billLName>
<billCompany xsi_type="xsd:string">Xxx</billCompany>
<billState xsi_type="xsd:string">NY</billState>
<billCity xsi_type="xsd:string">NEW YORK</billCity>
<billZip xsi_type="xsd:string">10012-2623</billZip>
<billCountry xsi_type="xsd:string">United States</billCountry>
<billAddress1 xsi_type="xsd:string">636 BROADWAY</billAddress1>
<billAddress2 xsi_type="xsd:string">RM 516</billAddress2>
<billAddress3 xsi_type="xsd:string"/>
<Residential xsi_type="xsd:string">NO</Residential>
<RequireSignature xsi_type="xsd:string">NO</RequireSignature>
<Priority xsi_nil="true" xsi_type="xsd:string"/>
<Note xsi_type="xsd:string"/>
<Status xsi_type="xsd:string">SHIPPED</Status>
<new_order_numbers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[0]"/>
<new_shipping_numbers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:string[0]"/>
<Items xsi_type="xsd:string">1</Items>
<HoldReleaseDate xsi_nil="true" xsi_type="xsd:string"/>
<Detaill SOAP-ENC:arrayType="tns:DetaillSku[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:DetaillSku">
<Sku xsi_type="xsd:string">PHI/670S</Sku>
<Qty xsi_type="xsd:string">1</Qty>
<SoldPrice xsi_type="xsd:string">0.00</SoldPrice>
<Description xsi_type="xsd:string"/>
<Currency xsi_type="xsd:string">USD</Currency>
<new_order_number xsi:type="xsd:string"/>
<new_shipping_number xsi:type="xsd:string"/>
</item>
</Detaill>
<DetaillCost xsi_nil="true" xsi_type="tns:DetaillCost"/>
</item>
</ordersResp>
</requestOrders>
</ns1:ordersDateStatusAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Create Orders

Create orders in status pending

If you need to send more than 10 orders per call, the Order Management will get processed by our linux servers in the background.

Method: addOrdersAccount
ordersList

Paremeter

Type

Description

ordersListarrayArray orders, type items(orders)

 

items(orders)

Paremeter

Type

Description

orderNum (*)varcharOrder# must be unique. You may use a shopping-cart or order processing software ID. It is recommended to use incremental consecutive numbers. If an Order# is repeated, the system will not import that row.
orderRefvarcharorderRef used by customer as their reference number. Many times will be the channel item number or transaction ID. For shopping carts you may use the customerID or nick name.
orderShipMethod (*)varchar
please refer to ship method codes table.
orderCommentsvarchar
personalized comments inside the packing slip.
custEmailvarchar
we can send order status updates to this email on your behalf.
custPhonevarcharYour customer’s delivery phone# is required on all international orders and express shipments. You may use your own phone number if you don’t have the buyers contact phone#.
custFName (*)varchar
Use as first name or as complete name.
custLNamevarchar
Last name after first name
custCompanyvarchar
If buyer is a company or organization
custAddress1 (*)varchar
street delivery address
custAddress2varcharapartment or unit number. International order may use this field for zone or area.
custCity (*)varchardelivery city name
custState (*)varcharstate or province
custZip (*)varchardelivery arear postal code.
custCountry (*)varchardelivery country name
custBillFNamevarcharBuyer first or complete name. Used for customer services purposes and order management. If left blank we will repeat the delivery address.
custBillLNamevarcharIf left blank we will repeat the delivery address
custBillCompanyvarcharIf left blank we will repeat the delivery address
custBillAddress1varcharIf left blank we will repeat the delivery address
custBillAddress2varcharIf left blank we will repeat the delivery address
custBillCityvarcharIf left blank we will repeat the delivery address
custBillStatevarcharIf left blank we will repeat the delivery address
custBillZipvarcharIf left blank we will repeat the delivery address
custBillCountryvarcharIf left blank we will repeat the delivery address
orderCODvarcharAmount to be picked up when shipment is delivered (only available through UPS — additional service fees apply).
orderInsurancevarcharIf insurance is required, please include the insurance amount otherwise leave blank (additional charges apply). UPS and FedEx automatically include insurance up to $100 at no additional charge.
orderReqSignaturevarcharYES or NO (blank or nill)
CheckoutDatevarcharpayment cleared date.
CartIDvarchar
If multiple you sell through multiple shopping carts.
ChannelIDvarcharIf multiple you sell through multiple Channels.
LogoIDvarcharTo be shown in the packing list. In case you use a different logo on multiple channels or shopping carts (not yet implemented).
NoteFromvarcharIf you would like to include your address or a different note specific for each order (not yet implemented).
ShipmentSubtotalvarcharTotal amount charged for merchandise not including shipping & handling charges.
ShippingChargevarcharShipping and Handling charges.
TotalChargevarcharTotal amount charged for merchandise plus shipping & handling charges.
ResidentialvarcharYES / NO. Used to attain different service levels by UPS or FedEx. We can fill this for you if you are subscribed to automatic address verification and residence status (this service will detect the status of the delivery and automatically select the correct service: Commercial or Residential)
CustCommentsvarcharComments received by customer during checkout.
WarehouseIDvarcharNot required for home warehouse. Only used by multi-warehouse users or drop-shipping.
DetaillSku (*)arrayArray of SKUs, type items(detail)

 

items(detail)

Paremeter

Type

Description

Sku (*)varcharThe SKU we need to place in the package.
Qty (*)varcharThe number of products for its respective SKU
SoldPricevarcharPrice sku selled
DescriptionvarcharDescription product selled

Response

items(detail)

Paremeter

Type

Description

NumRecordsvarcharThe number of orders that are sent using the addOrdersAccount.
MessagevarcharThe message describing the outcome of the addOrdersAccount method. Two possibilities:

  • Complete batch validated” (If you send up to 10 orders this message will appear).
  • 200 orders added to the Shipedge order validation queue. You will see them in Shipedge soon” (If you send more than 10 orders this message will appear. The number of orders which were processed/sent).
BatchIDvarcharThe number id that is assigned to the group of orders that were processed/sent.

Request

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/”     >
<SOAP-ENV:Body>
<ns1:addOrdersAccountResponse >
<ordersResponseAdd xsi_type="tns:addOrdersResponse">
<access xsi_type="tns:accessResponse">
<AccountID xsi_type="xsd:int">210</AccountID>
<AccessAccount xsi_type="xsd:string">Allow: addOrdersAccount</AccessAccount>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
<NumRecords xsi_type="xsd:string">180</NumRecords>
<Message xsi_type="xsd:string">Complete batch validated</Message>
<BatchId xsi_type="xsd:string">183281</BatchId>
</access>
<addListOrders xsi_type="tns:listArray">
<allow SOAP-ENC:arrayType="tns:ordersRespAddAllow[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:ordersRespAddAllow">
<orderNum xsi_type="xsd:string">999000_4</orderNum>
<OrderID xsi_type="xsd:string">196537</OrderID>
</item>
</allow>
<denied SOAP-ENC:arrayType="tns:ordersRespAddDenied[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:ordersRespAddDenied">
<orderNum xsi_type="xsd:string">999000_1</orderNum>
<CommentAPI xsi_type="xsd:string">Already in System</CommentAPI>
<OrderID xsi_type="xsd:string">196533</OrderID>
</item>
</denied>
</addListOrders>
</ordersResponseAdd>
</ns1:addOrdersAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Batch Information

This method can be used to check the status of Order Management Validations performed by linux in the background. The results will generally be visible to the user inside the Shipedge interface.

Method: batchIdInformation

access

Paremeter

Type

Description

AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
MessagevarcharThe message describing the outcome of the addOrdersAccount method. Two possibilities:

  • Complete batch validated” (If you send up to 10 orders this message will appear).
  • 200 orders added to the Shipedge order validation queue. You will see them in Shipedge soon” (If you send more than 10 orders this message will appear. The number of orders which were processed/sent).
BatchIDvarcharThe number id that is assigned to the group of orders that were processed/sent.
Kindvarchar Orders; The type of information that is requested. In this case it would be: Orders (We will build on this variable in the future since it can be used to request information from other types such as “Inventory” or any other parameter we wish to add).
Example
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"     >
<SOAP-ENV:Body>
<tns:batchIdInformation >
<access xsi_type="tns:access">
<AccountID xsi_type="xsd:int">210</AccountID>
<Key xsi_type="xsd:string">xxxxxx</Key>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
</access>
<variable xsi_type="tns:variable">
<BatchId xsi_type="xsd:string">183281</BatchId>
<Kind xsi_type="xsd:int">Orders</Kind>
</variable>
</tns:batchIdInformation>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<SOAP-ENV:Envelope     >
<SOAP-ENV:Body>
<ns1:batchIdInformationResponse >
<ordersResponseAdd xsi_type="tns:addOrdersResponse">
<access xsi_type="tns:accessResponse">
<AccountID xsi_type="xsd:int">210</AccountID>
<AccessAccount xsi_type="xsd:string">Allow: batchIdInformation</AccessAccount>
<Warehouse xsi_type="xsd:string">demo</Warehouse>
<NumRecords xsi_type="xsd:string">100</NumRecords>
<Message xsi_type="xsd:string">Complete batch validated</Message>
<BatchId xsi_type="xsd:string">183288</BatchId>
<Kind xsi_type="xsd:string">Orders</Kind>
</access>
<addListOrders xsi_type="tns:listArray">
<allow SOAP-ENC:arrayType="tns:ordersRespAddAllow[99]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:ordersRespAddAllow">
<orderNum xsi_type="xsd:string">x999000_6z3800</orderNum>
<OrderID xsi_type="xsd:string">215608</OrderID>
</item>
</allow>
<denied SOAP-ENC:arrayType="tns:ordersRespAddDenied[1]" xsi_type="SOAP-ENC:Array">
<item xsi_type="tns:ordersRespAddDenied">
<orderNum xsi_type="xsd:string">x999000_6z3893</orderNum>
<CommentAPI xsi_type="xsd:string">Check Field:OrderNumber</CommentAPI>
<OrderID xsi_type="xsd:string">0</OrderID>
</item>
</denied>
</addListOrders>
</ordersResponseAdd>
</ns1:batchIdInformationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

 

Last updated byShipedge on October 23, 2018