Asia-Pacific (APAC) Services for Newgistics

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

Overview

APAC Services provide regional URIs to optimize performance for Newgistics® requests that originate in the Asia-Pacific region.

Operations

APAC Services provide regional URIs for the following operations. If you use APAC Services to create a shipment, you must also use APAC Services if you manifest or void the shipment:

  • Create Newgistics Label

    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 Newgistics 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 Newgistics Label

    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.

Considerations

The information provided on the Newgistics reference page also applies to APAC Services, with the following exceptions:

  • You cannot use the Reprint or Retry operations for a label created through APAC Services.
  • For label settings, see the Label Settings for APAC Services below. Do not use the settings listed on the Newgistics reference page.

Authentication

APAC Services use the OAuth Token generated through the OAuth Token API.

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 label can be returned only as a Base64-encoded string. It cannot be returned as a URL.
  • 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
(size)
File Format
(fileFormat)
Content Type
(contentType)
DPI
(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.