Onboard-MerchantLogos API

1.0.x
(0 reviews)
Experience API created for generation logo_id

Introduction

The Onboard-MerchantLogos API enables you to create logos to be printed on your label. This API can be used to get a logo_id by passing your logo in base64 format.

When customers wants to print their logos on the label being called via our ParcelLabel V3 API https://anypoint.mulesoft.com/exchange/portals/nz-post-group/b8271f09-2ad8-4e1c-b6b1-322c5727d148/parcellabel-api/, the Onbaord-MerchantLogos API can be called as a pre-requisite for getting a logo_id. The API needs your logo to be passed in base64 format. On a successfuly response, the API will provide a logo_id. The initial PNG or JPEG format for the logos need to be 1480 pixels wide by 380 pixels high.

Onboard-Merchant Logos API includes the following resources:

Name Function Verb
Create Logo Request for creating one logo_id. POST

Pre-requisites

In order for you to gain access to the APIs, you and your organisation must meet the following pre-requisites:

  1. Your organisation must have an active NZ Post or CourierPost account number.
  2. You must be registered with the Developer Portal. You can register here by completing the registration form. The email address you provide on the registration form will be your Developer Portal username.
  3. You must have reviewed and accepted the Terms and Conditions for use of the NZ Post Group APIs.
  4. You must have requested and received access to the API.

Support

For developer integration enquiries, please email techsupport@nzpost.co.nz. Support is available during New Zealand business hours.

Reviews