How can I retrieve a report of all my pending orders?

Want to create a complete report of all your orders that still have to be shipped and easily keep everything under control?

You can use GetPendingOrders to retrieve orders that have not yet been shipped. Let's see how your internal application can retrieve imported orders before shipment.

Summary:

1. Retrieve pending orders
2. Understand the response data
3. Check API access requirements
4. API retrieval, Automation triggers and webhooks

1. Retrieve pending orders

Your internal application can retrieve Amazon and WiziShop orders already imported into ShippyPro before they are shipped, using GetPendingOrders.

1. Set Method to GetPendingOrders in your request.
2. Include DateMin and DateMax in Params to specify your date range.

Request template:

{
"Method": "GetPendingOrders",
"Params": {
"DateMin": "DATE_MIN",
"DateMax": "DATE_MAX"
}
}

Replace DATE_MIN and DATE_MAX with your dates in the format specified in the ShippyPro API documentation. These are placeholders, not date values.

2. Understand the response data

With GetPendingOrders call you'll be able to:

The response includes order details, item details and recipient information. The relevant API field names are:

• Order fields: transaction_id, date, status, marketplace_platform and marketplace_id.
• Item fields: title, quantity, price, sku and attributes.
• Recipient fields: name, company, phone, email, address, address2, postcode, city, country and state.

The order data described by this call also includes:

• Transaction ID
• Date
• Currency
• Items
• Title
• Quantity
• Price
• SKU
• Items Description
• Total
• Status
• Name
• Company
• Phone
• Address
• Address2
• Postcode
• City
• Country
• State
• Email
• Marketplace Platform
• Marketplace ID
• Insurance
• Insurance amount
• Shipment Amount Paid
• Payment Method
• Note
• User Note
• Shipping Service
• Incoterm
• Bill Account no
• Archived
• Merged

3. Check API access requirements

API access requires the Professional plan and is included in that plan. You cannot purchase or activate API access separately from the plan.

To upgrade from your account:

1. Open Plan & Billing.
2. Click Upgrade to Professional.

For the full upgrade instructions and subscription conditions, see ShippyPro Pricing, Payments and Plans.

4. API retrieval, Automation triggers and webhooks

GetPendingOrders retrieves pending-order data when your application makes an API request. It is different from an Automation trigger.

The Order is imported trigger operates only within Automation in ShippyPro. It is not an external new-order webhook for your application. See the Automation glossary for trigger details.

The documented webhook events are Order Shipped, Order Error and Tracking Updates. For webhook setup, see How do I connect Webhooks?