Asia-Pacific (APAC) Services for PB Standard Delivery

For Chinese, click here. (请点击这里查看中文.)

Overview

APAC Services provide regional URIs to optimize performance for PB Standard Delivery requests that originate in the Asia-Pacific Region. APAC Services provide URIs for the following PB Standard 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 do not provide URIs for other Shipping APIs operations. For all other operations, use the URI listed on the operation’s documentation page.

APAC Services Operations

APAC Services provide regional URIs for the following operations:

  • Create a PB Standard Delivery Shipment

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

  • Create a PB Standard Delivery Manifest (Closeout)

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

  • Void a PB Standard Delivery Shipment

    Sandbox URI APAC: https://apac-sandbox.shippingapi.pitneybowes.com/shippingservices/v1/shipments/{shipmentId}?carrier=Newgistics
    Production URI APAC: https://apac.shippingapi.pitneybowes.com/shippingservices/v1/shipments/{shipmentId}?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.

Important

The Create Manifest operation does not return the manifestId field.

APAC Services Considerations

  • APAC Services do not provide a URI for authentication. Use the URI listed on the Generate an OAuth Token page.
  • APAC Services do not provide a URI for the Print Container Label operation. Use the URI listed on the Create a Container Label page.
  • The APAC Services operation for to Create a Manifest does not return the manifestId field.
  • Before shipping with PB Standard, see the PB Standard reference page. The information on the reference 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 the APAC Services:

  • The label size, as specified in the documents.size field, uses an upper-case X. Using a lower-case x will result in an error.
  • If you set the file format 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 file format to ZPL2 and the content type 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 URIs. Set label options in the Documents Object:

Labels Printed with APAC URIs
Label Size
File Format Content Type Resolution
DOC_4X4 PDF
PNG
ZPL2 [1]
BASE64
BASE64
BASE64 [2]
DPI_203
DPI_203
DPI_203 (default),
DPI_300
DOC_4X5 PDF
PNG
ZPL2 [1]
BASE64
BASE64
BASE64 [2]
DPI_203
DPI_203
DPI_203 (default),
DPI_300
DOC_4X6 PDF
PNG
ZPL2 [1]
BASE64
BASE64
BASE64 [2]
DPI_203
DPI_203
DPI_203 (default),
DPI_300
[1](1, 2, 3) If you have an older printer that does not support Unicode, please see this topic.
[2](1, 2, 3) If set the file format to ZPL2, the label is returned as raw ZPL.