Neoship Api (1.0.0)

Login to Neoship to obtain a token

Refresh JWT token after expriation

Create new package

Bulk action to create new packages. Packages are created only if all values are valid. If one package is invalid no one package is created

Combined endpoint that creates packages and immediately prints stickers in a single call. The label PDF is saved to storage (accessible via GET /package/{id}/label) and is not returned in the response.

This endpoint combines the functionality of POST /package/bulk/{shipper_id} (package creation) and POST /package/bulk/ with action=send_print_sticker (sticker printing) into one atomic operation.

Info package

Edit package which has not been exported

Delete package which has not been exported

Downloads the label PDF for a package that has been exported (sticker printed). The label must have been previously generated via POST /package/bulk/ with action=send_print_sticker or via POST /package/bulk-create-and-print/{shipper_id}.

Cancel package. Cancels the shipment at the shipper and marks the package as cancelled. Reference number is prefixed with X. Only packages in shipping (not yet exported) or service packages can be cancelled.

List of packages

List of packages by the list of reference numbers. If the list of reference numbers contains invalid reference numbers, the packages corresponding to invalid reference numbers are not included in response content.

Bulk action for getting stickers or acceptance protocol.

Calculate available package shipping quotes for the authenticated user.

Calculate available package shipping quotes for a selected user. The response includes purchase prices when available.

Detail about user

List of parcelshop

Detail of parcelshop

Tracking of packages by tracking number. This is usefull, if you want to show the information in your app.

Tracking of packages by reference number and user id. This tracking is returning the page with the styles, not needed parsing response or anything else.

Tracking of packages by tracking number. This tracking is returning the page with the styles, not needed parsing response or anything else.

The parcelshop picker is an embeddable iframe UI for selecting a parcelshop from a map and list. It is intended for checkout or shipment forms where the customer chooses a delivery point.

The picker is not a JSON API endpoint. Render it in an iframe or open it with your own modal, then listen for window.postMessage events from the iframe. Use https://app.neoship.sk for production and https://app.nshptest.sk for testing.

Basic iframe

<iframe
  src="https://app.neoship.sk/neoship/parcelshop-picker/?apiKey=XXXXXXXXXXXXX"
  title="Výber parcelshopu"
  allow="geolocation"
  style="width: 100%; height: 700px; border: 0;"
></iframe>

For usage on your own domain, create a parcelshop picker API key in Neoship and store the exact parent page origin for that key, for example https://eshop.example. One key can have multiple allowed origins in Neoship. External iframe usage sends apiKey; Neoship uses the stored origins to decide where the iframe may be embedded. If apiKey is omitted, the picker is only intended for Neoship's own origin.

Receiving the selected parcelshop

const pickerOrigin = "https://app.neoship.sk";

window.addEventListener("message", (event) => {
  if (event.origin !== pickerOrigin) {
    return;
  }

  const message = event.data || {};

  if (message.type === "neoship:parcelshop-picker:selected") {
    const parcelshop = message.detail;
    // Save parcelshop.parcelshopId into your order/package parcelshop field.
  }

  if (message.type === "neoship:parcelshop-picker:close") {
    // Close your modal or hide the iframe.
  }
});

Posted messages

The iframe sends these message types to the parent window:

• neoship:parcelshop-picker:ready - picker loaded and initialized
• neoship:parcelshop-picker:selected - user selected a parcelshop
• neoship:parcelshop-picker:error - picker initialization or data loading failed
• neoship:parcelshop-picker:close - user clicked close or pressed Escape

Selection payload

The neoship:parcelshop-picker:selected message contains the selected parcelshop in event.data.detail:

{
  "shipperId": "3",
  "parcelshopId": "12345",
  "name": "Parcelshop name",
  "street": "Main street 1",
  "zip": "81101",
  "city": "Bratislava",
  "stateCode": "SK",
  "lat": 48.1486,
  "lng": 17.1077,
  "openingHours": null,
  "boxType": null,
  "occupancyStatus": null
}

Use parcelshopId as the parcelshop value when creating a parcelshop package.