API Reference

Providing available services

When adding a carrier, Fulfil will make an initial request to discover available carrier services. These services can then be used by merchants to create automation rules.

Example request

GET <YOUR CALLBACK URL>/services

Example expected response

You response should include the following required fields

[
    {"code": "SD", "name": "Same day delivery"},
    {"code": "ND", "name": "Next day delivery"}
]
FieldDescriptionRequired?
codeCode for the service. This code is expected to be returned when rates are requested and will also be sent to the carrier when generating labels.Yes
nameDescriptive name of the serviceYes

Best practice

  • Provide all services (for example domestic and international) that are available for the merchant even if they don't use all of them today
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!