Amazon Selling Partner

Selling Partner API for Services

With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.

E-commerce#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.

Endpoints 17

service

  • GETgetServiceJobByServiceJobId/service/v1/serviceJobs/:serviceJobIdGets details of service job indicated by the provided serviceJobID. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits…
  • PUTcancelServiceJobByServiceJobId/service/v1/serviceJobs/:serviceJobId/cancellations?cancellationReasonCode=stringCancels the service job indicated by the service job identifier specified. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate…
  • PUTcompleteServiceJobByServiceJobId/service/v1/serviceJobs/:serviceJobId/completionsCompletes the service job indicated by the service job identifier specified. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan…
  • GETgetServiceJobs/service/v1/serviceJobs?serviceOrderIds=string&productOrderIds=string&trackingIds=string&serviceJobStatus=NOT_SERVICED&pageToken=string&pageSize=20&sortField=JOB_DATE&sortOrder=ASC&createdAfter=string&createdBefore=string&lastUpdatedAfter=string&lastUpdatedBefore=string&scheduleStartDate=string&scheduleEndDate=string&marketplaceIds=string&asins=string&requiredSkills=string&storeIds=string&providerServiceJobReferenceIds=stringGets service job details for the specified filter query. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were…
  • POSTaddAppointmentForServiceJobByServiceJobId/service/v1/serviceJobs/:serviceJobId/appointmentsAdds an appointment to the service job indicated by the service job identifier specified. Usage Plan: The x-amzn-RateLimit-Limit response header returns the…
  • POSTrescheduleAppointmentForServiceJobByServiceJobId/service/v1/serviceJobs/:serviceJobId/appointments/:appointmentIdReschedules an appointment for the service job indicated by the service job identifier specified. Usage Plan: The x-amzn-RateLimit-Limit response header…
  • PUTassignAppointmentResources/service/v1/serviceJobs/:serviceJobId/appointments/:appointmentId/resourcesAssigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. Usage Plan: The x-amzn-RateLimit-Limit response header returns…
  • PUTsetAppointmentFulfillmentData/service/v1/serviceJobs/:serviceJobId/appointments/:appointmentId/fulfillmentUpdates the appointment fulfillment data related to a given jobID and appointmentID. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage…
  • POSTgetRangeSlotCapacity/service/v1/serviceResources/:resourceId/capacity/range?marketplaceIds=string&nextPageToken=stringProvides capacity slots in a format similar to availability records. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits…
  • POSTgetFixedSlotCapacity/service/v1/serviceResources/:resourceId/capacity/fixed?marketplaceIds=string&nextPageToken=stringProvides capacity in fixed-size slots. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the…
  • PUTupdateSchedule/service/v1/serviceResources/:resourceId/schedules?marketplaceIds=stringUpdate the schedule of the given resource. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the…
  • POSTcreateReservation/service/v1/reservation?marketplaceIds=stringCreate a reservation. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation,…
  • PUTupdateReservation/service/v1/reservation/:reservationId?marketplaceIds=stringUpdate a reservation. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation,…
  • DELETEcancelReservation/service/v1/reservation/:reservationId?marketplaceIds=stringCancel a reservation. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation,…
  • GETgetAppointmmentSlotsByJobId/service/v1/serviceJobs/:serviceJobId/appointmentSlots?marketplaceIds=string&startTime=string&endTime=stringGets appointment slots for the service associated with the service job id specified. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage…
  • GETgetAppointmentSlots/service/v1/appointmentSlots?asin=string&storeId=string&marketplaceIds=string&startTime=string&endTime=stringGets appointment slots as per the service context specified. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that…
  • POSTcreateServiceDocumentUploadDestination/service/v1/documentsCreates an upload destination. Usage Plan: The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested…

API details

Base URL
https://sellingpartnerapi-na.amazon.com
Authentication
None declared in the description
Operations
17 operations on 16 pathsPUT 6POST 6GET 4DELETE 1
Main resources
service 17
Response formats
application/json
Description format
Swagger 2.0, API version v1

How to test the Selling Partner API for Services in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Selling Partner API for Services collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “getServiceJobByServiceJobId” (GET /service/v1/serviceJobs/:serviceJobId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Selling Partner API for Services?

With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources. It is listed under E-commerce and has 17 endpoints.

Who publishes the Selling Partner API for Services?

It is listed from Amazon Selling Partner's public API description (an OpenAPI document), not published by Amazon Selling Partner on Swastik Codes. Anyone who controls sellingpartnerapi.amazon.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Selling Partner API for Services?

Requests go to https://sellingpartnerapi-na.amazon.com. Endpoint paths are added to this base URL.

How do I authenticate with the Selling Partner API for Services?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Selling Partner API for Services have?

17 operations on 16 paths (6 PUT, 6 POST, 4 GET, 1 DELETE). The largest groups are service.

Is forking the Selling Partner API for Services free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.