Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

APG eCommerce

APG eCommerce is one of the leading suppliers of cross-border ecommerce delivery solutions with an established presence in Asia, Europe, and the US. ShipStation API's integration with APG eCommerce provides international shipping services for shipments originating in the US, Great Britain, Australia, the Netherlands, Hong Kong, Singapore, the United Arab Emeriates, and Saudi Arabia.

This guide provides developers with the details needed to build APG eCommerce shipping capabilities into your ShipStation API workflows.

Requirements

PropertyTypeRequired?Description
nicknamestringrequiredIdentifies your account in ShipStation API
usernamestringrequiredAPG account username
passwordstringrequiredAPG account password
sender_codestringOptionalAPG Sender Code

Connect Account

You can connect a APG eCommerce account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipStation API Dashboard.

For instructions to connect an APG eCommerce account via the ShipStation API dashboard, review our APG eCommerce help article.

Connect via Endpoint

carrier_name: apg_ecommerce

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/apg_ecommerce HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "My APG ecommerce nickname",
"username": "YourUserName",
"password": "123456789"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Rates

APG eCommerce supports rate shopping with ShipStation API.

Service Details

Available APG eCommerce services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

International Services

ServiceAPI CodeOrigina Countries
ePacketepacketUS, NL, HK, GB
ePacket Plusepacket_plusUS, NL, HK, GB
eParcel Premiumeparcel_premiumUS, NL, HK, GB
eParcel Expeditedeparcel_expeditedUS, NL, HK, GB
eParcel Expresseparcel_expressUS, NL, HK, GB
eParcel Premium PUDOeparcel_premium_pudoUS, NL, HK, GB
eParcel Expedited PUDOeparcel_expedited_pudoUS, NL, HK, GB
eReturn Drop Offereturn_drop_offUS, NL, HK, GB
eReturn Drop Off Intlereturn_drop_off_intlUS, NL, HK, GB
eReturn Pick upereturn_pick_upUS, NL, HK, GB, AE, SA
eReturn Pick up Intlereturn_pick_up_intlUS, NL, HK, GB, AE, SA

Return Services

Return labels can be created with the eReturn services.

Review the Return Shipping Labels page for details on creating return labels with ShipStation API.

Packages

The following carrier package types are available for APG eCommerce services:

NameAPI CodePackage Attributes
Packageapg_ecommerce_packageInternational

Adding Shipment Insurance

Adding shipment insurance is supported with APG. Please contact APG eCommerce for specific details on the insurance coverage available for each service.

Review the Parcel Insurance page for details on adding shipment insurance with ShipStation API.

Label Support

  • Label sizes: 4" x 6"
  • Label formats: PDF, PNG, ZPL

Label Reference Fields

APG eCommerce does not support adding custom label messages.

Multi-Package Labels

APG eCommerce supports creating multi-package shipments with all available services.

Label Branding

APG eCommerce supports label branding.

Voiding Labels

APG eCommerce does not support voiding labels with ShipStation API.

Paperless Labels

APG eCommerce does not support paperless labels.

Customs Declarations

Customs declarations are provided via a commercial invoice. You can download the commercial invoice from the forms_download property in the label response.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
No confirmation requirednoneWhen no delivery confirmation is required for the shipment.
Signaure requiredsignatureWhen a signature is required to complete delivery.

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

APG eCommerce supports certain advanced options, which you can add to the shipment object when creating a shipment or label.

OptionTypeDefault ValueDescription
additional_handlingbooleannullIndicates the package requires special handling.
collect_on_deliveryobjectnullDefers payment to recipient when package is delivered. See our Collect on Delivery page for details about using this property.
dangerous_goodsbooleanfalseIndicates if dangerous goods or hazardous materials are present in the shipment.
delivered_duty_paidbooleanfalseIndicates the shipment is DDP (that is, the shipper is paying the duties/taxes for the shipment rather than the recipient).

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Dangerous Goods

When shipping dangerous goods, APG eCommerce requires both the dangerous_goods property be set to true and the package level dangerous goods properties are included.

See our Dangerous Goods page for more details about these properties and confirm with your APG account contact which properties they require.

Manifests

APG eCommerce does not require manifesting your shipments.

Scheduling Pickups

APG eCommerce does not support scheduling pickups using ShipStation API.

Service Points (PUDO)

APG eCommerce supports shipping to service points with their PUDO-specific services.

Tracking

ShipStation API's integration with APG eCommerce supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.

Disconnecting Your APG eCommerce Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.