Asia-Pacific (APAC) Services for PB Delivery¶

Overview¶

APAC Services provides regional URLs to optimize performance for PB Delivery requests that originate in the Asia-Pacific Region. APAC Services provides URLs for the following PB Delivery API operations:

Create Shipment
Create Manifest
Void Shipment

If you use APAC Services to create a shipment, you must also use APAC Services if you manifest or void the shipment.

APAC Services does not provide URLs for other Ecommerce API operations. For all other operations, use the URL listed on the operation’s documentation page.

APAC Services Operations¶

APAC Services provides regional URLs for the following operations:

Create a PB Delivery Shipment

Sandbox URL APAC: https://apac-sandbox.shippingapi.pitneybowes.com/shippingservices/v1/shipments?carrier=Newgistics
Production URL APAC: https://apac.shippingapi.pitneybowes.com/shippingservices/v1/shipments?carrier=Newgistics

Important

If you use APAC Services to create a shipment, you must also use APAC Services if you manifest or void the shipment.
Create a PB Delivery Manifest (Closeout)

Sandbox URL APAC: https://apac-sandbox.shippingapi.pitneybowes.com/shippingservices/v1/manifests?carrier=Newgistics
Production URL APAC: https://apac.shippingapi.pitneybowes.com/shippingservices/v1/manifests?carrier=Newgistics

Important

The Create Manifest operation does not return the manifestId field.
Void a PB Delivery Shipment

Sandbox URL APAC: https://apac-sandbox.shippingapi.pitneybowes.com/shippingservices/v1/shipments/{shipmentId}?carrier=Newgistics
Production URL APAC: https://apac.shippingapi.pitneybowes.com/shippingservices/v1/shipments/{shipmentId}?carrier=Newgistics

APAC Services Considerations¶

To generate an OAuth token use the URL listed on the Generate OAuth Token page. APAC Services does not provide a regional URL for token generation.
APAC Services provides regional URLs only for the operations listed above (Create Shipment, Void Shipment, Create Closeout).

For operations not listed above, use the URL listed on the operation’s documentation page.
The Create Shipment operation does not support address validation. APAC Services does not validate addresses.
The Create Closeout operation does not return the manifestId field.
Before shipping with PB, see the PB Expedited and Standard Services page. The page also applies to APAC Services, with following exceptions:
- Shipments created with APAC Services do not use the label settings listed on the reference page. They instead use the label settings listed below in Label Settings for APAC Services.
- Shipments created with APAC Services cannot be reprinted or retried. Do not use the Reprint or Retry operations for labels created with APAC Services.

Label Settings for APAC Services¶

Please read the following considerations before printing a label using APAC Services:

Label size values use an uppercase X. Do not use a lowercase x.
If you set the fileFormat to PDF, you must set contentType to BASE64. The PDF label can be returned only as a Base64-encoded string. It cannot be returned as a URL. To decode the string as a PDF, use a tool that converts Base64 to the application/pdf MIME type.
If you set the fileFormat to ZPL2 and the contentType to BASE64, the label is returned as raw ZPL, not as a Base64-encoded string.
By default, the APIs print ZPL2 labels using the Unicode character set. If you have an older printer that does not support Unicode, see this Troubleshooting topic.
Advise shippers on correct label placement. Please see What is the correct placement for a shipping label?

The table below describes the options for labels printed with the APAC URLs. Set label options in the Documents Object:

Labels Printed with APAC URLs¶
size	fileFormat	contentType	resolution
DOC_4X5	PDF PNG ZPL2	BASE64 BASE64 BASE64 1	DPI_203 DPI_203 DPI_203 (default), DPI_300
DOC_4X6	PDF PNG ZPL2	BASE64 BASE64 BASE64 1	DPI_203 DPI_203 DPI_203 (default), DPI_300

1(1,2)

If fileFormat is ZPL2, the label is returned as raw ZPL.