Skip to content
FirstMile
/
Label API
/
/
Migration Notes

FirstMile Label Server REST API (1.0)

The FirstMile Label Server REST API provides endpoints for label creation, rate shopping, meter management, and manifesting shipments. This API replaces the legacy SOAP interface. All endpoints, request/response models, and business logic are documented here, with migration notes for users transitioning from SOAP.

Authentication

The API uses OAuth 2.0 Bearer token authentication with policy-based authorization:

  • Label operations require 'fm.external.rest.labelserver.label' scope
  • Rate operations require 'fm.external.rest.labelserver.rate' scope
  • Meter operations require 'fm.external.rest.labelserver.meter' scope

The API validates claims including 'fm.api.companyId' (IFS ID) and 'fm.api.techPartnerId'.

Migration Notes

  • All SOAP methods are now available as REST endpoints
  • Request and response models are mapped to OpenAPI schemas
  • See the migration guide for detailed mapping and examples
Download OpenAPI description
swagger.json
swagger.yaml
Languages
Servers
Mock server

https://developer.fastgroup.co/_mock/xmethod/label/rest/swagger/

Test server

https://labelserver-test.firstmile.com/

Production server

https://labelserver.firstmile.com/

Label

Operations

Meter

Operations

Rate

Operations