FeatureIntegration
Globe API: Labels, Orders and Pickup Points (Beta)
A REST API for your store's labels, orders and pickup points, with webhooks. Build a one-click print station, sync labels into your ERP, or set a pickup point from your own tools.
The Globe API gives your own systems access to the shipping labels, orders and pickup points of your store. Use it for a desktop app that prints each label with one click, a warehouse system that pulls labels as they are created, or an ERP that sets the pickup point itself.
Labels
- List and sync labels, with status, tracking number and carrier
- Download label PDFs: one label, all labels of an order, or a whole batch in one file
- Mark labels as printed, with your print tag applied
- Create labels with your own carrier accounts, with a dry run first if you like
Orders and pickup points
- Read an order as Globe sees it: pickup point, reminder e-mails, delivery status, cash on delivery and labels
- Find the nearest pickup points for an order, and set or change its pickup point, just like Edit pickup point in the admin
Webhooks
shipping_label.createdfor every new label, with the PDF or without it, as you chooselabel_creation.updatedwhen a label created through the API changes state
Keys you control
- One key per packing station or integration, each with its own permissions: Read labels, orders and pickup points, Print labels, Change an order's pickup point, Create labels
- Rotate a key with an overlap, or revoke it at once. Globe e-mails the store whenever a key is created, rotated or revoked
- The Developer console in Settings → API lists your store's API requests
The API is in beta and turned on per store: ask us in the support chat in Globe, and say if you also want to create labels through it. Every endpoint, with an OpenAPI file, is in the documentation.