Services API

You use the Shipment Invoicing API to retrieve shipment invoice information for Fulfillment by Amazon (FBA) orders in the Brazil marketplace.

Release notes

For releases prior to January 19, 2022, refer to Announcements in the Selling Partner API GitHub repository.

To learn more about the terms that are used on this page, refer to Terminology.

Operations in the Services API

The operations in the Services API fall into four categories:

The combination of operations a service seller requires depends on the specific case arranged between them and their Amazon business line partners.

For example, the operations in the Closing Service Jobs category may not be able to substitute for a field technician using an Amazon-required mobile app. Service sellers should consult their relevant Amazon business line partners to settle appropriate API usage scope before initiating integration with the Services API.

Use cases

The following use cases are available for the Services API:

• Get Service Job data: Obtain Service Job data to determine the Jobs that require a service seller to take action and the Jobs that need additional API calls.
• Get service job appointment slots: Retrieve current appointment availability, available resource capacity, and existing jobs.
• Setting service job appointments and assigning appointment resources: Add or reschedule appointments for service jobs, and assign appointment resources.
• Closing service jobs: Set fulfillment data and set a job as complete.
• Manage resource capacity schedules and reservations: Manage service resource capacity schedules and support appointment availability and reservations that exclude scheduled capacity from appointment availability.

Roles for the Services API v1

addAppointmentForServiceJobByServiceJobId

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

assignAppointmentResources

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

cancelReservation

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

cancelServiceJobByServiceJobId

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

completeServiceJobByServiceJobId

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

createReservation

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

createServiceDocumentUploadDestination

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

getAppointmentSlots

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

getAppointmmentSlotsByJobId

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

getFixedSlotCapacity

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

getRangeSlotCapacity

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

getServiceJobByServiceJobId

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

getServiceJobs

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

rescheduleAppointmentForServiceJobByServiceJobId

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

setAppointmentFulfillmentData

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

updateReservation

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)

updateSchedule

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Professional Services (Restricted)