swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

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

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: v1
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request
ServiceApi	AddAppointmentForServiceJobByServiceJobId	Post /service/v1/serviceJobs/{serviceJobId}/appointments
ServiceApi	AssignAppointmentResources	Put /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/resources
ServiceApi	CancelReservation	Delete /service/v1/reservation/{reservationId}
ServiceApi	CancelServiceJobByServiceJobId	Put /service/v1/serviceJobs/{serviceJobId}/cancellations
ServiceApi	CompleteServiceJobByServiceJobId	Put /service/v1/serviceJobs/{serviceJobId}/completions
ServiceApi	CreateReservation	Post /service/v1/reservation
ServiceApi	CreateServiceDocumentUploadDestination	Post /service/v1/documents
ServiceApi	GetAppointmentSlots	Get /service/v1/appointmentSlots
ServiceApi	GetAppointmmentSlotsByJobId	Get /service/v1/serviceJobs/{serviceJobId}/appointmentSlots
ServiceApi	GetFixedSlotCapacity	Post /service/v1/serviceResources/{resourceId}/capacity/fixed
ServiceApi	GetRangeSlotCapacity	Post /service/v1/serviceResources/{resourceId}/capacity/range
ServiceApi	GetServiceJobByServiceJobId	Get /service/v1/serviceJobs/{serviceJobId}
ServiceApi	GetServiceJobs	Get /service/v1/serviceJobs
ServiceApi	RescheduleAppointmentForServiceJobByServiceJobId	Post /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}
ServiceApi	SetAppointmentFulfillmentData	Put /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/fulfillment
ServiceApi	UpdateReservation	Put /service/v1/reservation/{reservationId}
ServiceApi	UpdateSchedule	Put /service/v1/serviceResources/{resourceId}/schedules

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* 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. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AddAppointmentRequest
type Address
type Appointment
type AppointmentResource
type AppointmentSlot
type AppointmentSlotReport
type AppointmentTime
type AppointmentTimeInput
type AssignAppointmentResourcesRequest
type AssignAppointmentResourcesResponse
type AssignAppointmentResourcesResponsePayload
type AssociatedItem
type AvailabilityRecord
type BasicAuth
type Buyer
type CancelReservationResponse
type CancelServiceJobByServiceJobIdResponse
type CapacityType
type CompleteServiceJobByServiceJobIdResponse
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateReservationRecord
type CreateReservationRequest
type CreateReservationResponse
type CreateServiceDocumentUploadDestination
type DayOfWeek
type EncryptionDetails
type FixedSlot
type FixedSlotCapacity
type FixedSlotCapacityErrors
type FixedSlotCapacityQuery
type FulfillmentDocument
type FulfillmentTime
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetAppointmentSlotsResponse
type GetServiceJobByServiceJobIdResponse
type GetServiceJobsResponse
type ItemDelivery
type ItemDeliveryPromise
type JobListing
type ModelError
type Poa
type RangeCapacity
type RangeSlot
type RangeSlotCapacity
type RangeSlotCapacityErrors
type RangeSlotCapacityQuery
type Recurrence
type RescheduleAppointmentRequest
type Reservation
type ScopeOfWork
type Seller
type ServiceApiGetAppointmentSlotsOpts
type ServiceApiGetAppointmmentSlotsByJobIdOpts
type ServiceApiGetFixedSlotCapacityOpts
type ServiceApiGetRangeSlotCapacityOpts
type ServiceApiGetServiceJobsOpts
type ServiceApiService
- func (a *ServiceApiService) AddAppointmentForServiceJobByServiceJobId(ctx context.Context, body AddAppointmentRequest, serviceJobId string) (SetAppointmentResponse, *http.Response, error)
- func (a *ServiceApiService) AssignAppointmentResources(ctx context.Context, body AssignAppointmentResourcesRequest, ...) (AssignAppointmentResourcesResponse, *http.Response, error)
- func (a *ServiceApiService) CancelReservation(ctx context.Context, reservationId string, marketplaceIds []string) (CancelReservationResponse, *http.Response, error)
- func (a *ServiceApiService) CancelServiceJobByServiceJobId(ctx context.Context, serviceJobId string, cancellationReasonCode string) (CancelServiceJobByServiceJobIdResponse, *http.Response, error)
- func (a *ServiceApiService) CompleteServiceJobByServiceJobId(ctx context.Context, serviceJobId string) (CompleteServiceJobByServiceJobIdResponse, *http.Response, error)
- func (a *ServiceApiService) CreateReservation(ctx context.Context, body CreateReservationRequest, marketplaceIds []string) (CreateReservationResponse, *http.Response, error)
- func (a *ServiceApiService) CreateServiceDocumentUploadDestination(ctx context.Context, body ServiceUploadDocument) (CreateServiceDocumentUploadDestination, *http.Response, error)
- func (a *ServiceApiService) GetAppointmentSlots(ctx context.Context, asin string, storeId string, marketplaceIds []string, ...) (GetAppointmentSlotsResponse, *http.Response, error)
- func (a *ServiceApiService) GetAppointmmentSlotsByJobId(ctx context.Context, serviceJobId string, marketplaceIds []string, ...) (GetAppointmentSlotsResponse, *http.Response, error)
- func (a *ServiceApiService) GetFixedSlotCapacity(ctx context.Context, body FixedSlotCapacityQuery, marketplaceIds []string, ...) (FixedSlotCapacity, *http.Response, error)
- func (a *ServiceApiService) GetRangeSlotCapacity(ctx context.Context, body RangeSlotCapacityQuery, marketplaceIds []string, ...) (RangeSlotCapacity, *http.Response, error)
- func (a *ServiceApiService) GetServiceJobByServiceJobId(ctx context.Context, serviceJobId string) (GetServiceJobByServiceJobIdResponse, *http.Response, error)
- func (a *ServiceApiService) GetServiceJobs(ctx context.Context, marketplaceIds []string, ...) (GetServiceJobsResponse, *http.Response, error)
- func (a *ServiceApiService) RescheduleAppointmentForServiceJobByServiceJobId(ctx context.Context, body RescheduleAppointmentRequest, serviceJobId string, ...) (SetAppointmentResponse, *http.Response, error)
- func (a *ServiceApiService) SetAppointmentFulfillmentData(ctx context.Context, body SetAppointmentFulfillmentDataRequest, ...) (string, *http.Response, error)
- func (a *ServiceApiService) UpdateReservation(ctx context.Context, body UpdateReservationRequest, marketplaceIds []string, ...) (UpdateReservationResponse, *http.Response, error)
- func (a *ServiceApiService) UpdateSchedule(ctx context.Context, body UpdateScheduleRequest, marketplaceIds []string, ...) (UpdateScheduleResponse, *http.Response, error)
type ServiceDocumentUploadDestination
type ServiceJob
type ServiceJobProvider
type ServiceLocation
type ServiceUploadDocument
type SetAppointmentFulfillmentDataRequest
type SetAppointmentResponse
type Technician
type UpdateReservationRecord
type UpdateReservationRequest
type UpdateReservationResponse
type UpdateScheduleRecord
type UpdateScheduleRequest
type UpdateScheduleResponse
type Warning

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	ServiceApi *ServiceApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Services API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddAppointmentRequest ¶

type AddAppointmentRequest struct {
	AppointmentTime *AppointmentTimeInput `json:"appointmentTime"`
}

Input for add appointment operation.

type Address ¶

type Address struct {
	// The name of the person, business, or institution.
	Name string `json:"name"`
	// The first line of the address.
	AddressLine1 string `json:"addressLine1"`
	// Additional address information, if required.
	AddressLine2 string `json:"addressLine2,omitempty"`
	// Additional address information, if required.
	AddressLine3 string `json:"addressLine3,omitempty"`
	// The city.
	City string `json:"city,omitempty"`
	// The county.
	County string `json:"county,omitempty"`
	// The district.
	District string `json:"district,omitempty"`
	// The state or region.
	StateOrRegion string `json:"stateOrRegion,omitempty"`
	// The postal code. This can contain letters, digits, spaces, and/or punctuation.
	PostalCode string `json:"postalCode,omitempty"`
	// The two digit country code, in ISO 3166-1 alpha-2 format.
	CountryCode string `json:"countryCode,omitempty"`
	// The phone number.
	Phone string `json:"phone,omitempty"`
}

The shipping address for the service job.

type Appointment ¶

type Appointment struct {
	AppointmentId string `json:"appointmentId,omitempty"`
	// The status of the appointment.
	AppointmentStatus string           `json:"appointmentStatus,omitempty"`
	AppointmentTime   *AppointmentTime `json:"appointmentTime,omitempty"`
	// A list of technicians assigned to the service job.
	AssignedTechnicians      []Technician `json:"assignedTechnicians,omitempty"`
	RescheduledAppointmentId string       `json:"rescheduledAppointmentId,omitempty"`
	Poa                      *Poa         `json:"poa,omitempty"`
}

The details of an appointment.

type AppointmentResource ¶

type AppointmentResource struct {
	// The resource identifier.
	ResourceId string `json:"resourceId,omitempty"`
}

The resource that performs or performed appointment fulfillment.

type AppointmentSlot ¶

type AppointmentSlot struct {
	// Time window start time in ISO 8601 format.
	StartTime time.Time `json:"startTime,omitempty"`
	// Time window end time in ISO 8601 format.
	EndTime time.Time `json:"endTime,omitempty"`
	// Number of resources for which a slot can be reserved.
	Capacity int32 `json:"capacity,omitempty"`
}

A time window along with associated capacity in which the service can be performed.

type AppointmentSlotReport ¶

type AppointmentSlotReport struct {
	// Defines the type of slots.
	SchedulingType string `json:"schedulingType,omitempty"`
	// Start Time from which the appointment slots are generated in ISO 8601 format.
	StartTime time.Time `json:"startTime,omitempty"`
	// End Time up to which the appointment slots are generated in ISO 8601 format.
	EndTime time.Time `json:"endTime,omitempty"`
	// A list of time windows along with associated capacity in which the service can be performed.
	AppointmentSlots []AppointmentSlot `json:"appointmentSlots,omitempty"`
}

Availability information as per the service context queried.

type AppointmentTime ¶

type AppointmentTime struct {
	// The date and time of the start of the appointment window in ISO 8601 format.
	StartTime time.Time `json:"startTime"`
	// The duration of the appointment window, in minutes.
	DurationInMinutes int32 `json:"durationInMinutes"`
}

The time of the appointment window.

type AppointmentTimeInput ¶

type AppointmentTimeInput struct {
	// The date, time in UTC for the start time of an appointment in ISO 8601 format.
	StartTime time.Time `json:"startTime"`
	// The duration of an appointment in minutes.
	DurationInMinutes int32 `json:"durationInMinutes,omitempty"`
}

The input appointment time details.

type AssignAppointmentResourcesRequest ¶

type AssignAppointmentResourcesRequest struct {
	Resources *[]AppointmentResource `json:"resources"`
}

Request schema for the `assignAppointmentResources` operation.

type AssignAppointmentResourcesResponse ¶

type AssignAppointmentResourcesResponse struct {
	Payload *AssignAppointmentResourcesResponsePayload `json:"payload,omitempty"`
	Errors  *[]ModelError                              `json:"errors,omitempty"`
}

Response schema for the `assignAppointmentResources` operation.

type AssignAppointmentResourcesResponsePayload ¶

type AssignAppointmentResourcesResponsePayload struct {
	Warnings *[]Warning `json:"warnings,omitempty"`
}

The payload for the `assignAppointmentResource` operation.

type AssociatedItem ¶

type AssociatedItem struct {
	// The Amazon Standard Identification Number (ASIN) of the item.
	Asin string `json:"asin,omitempty"`
	// The title of the item.
	Title string `json:"title,omitempty"`
	// The total number of items included in the order.
	Quantity int32  `json:"quantity,omitempty"`
	OrderId  string `json:"orderId,omitempty"`
	// The status of the item.
	ItemStatus string `json:"itemStatus,omitempty"`
	// The brand name of the item.
	BrandName    string        `json:"brandName,omitempty"`
	ItemDelivery *ItemDelivery `json:"itemDelivery,omitempty"`
}

Information about an item associated with the service job.

type AvailabilityRecord ¶

type AvailabilityRecord struct {
	// Denotes the time from when the resource is available in a day in ISO-8601 format.
	StartTime time.Time `json:"startTime"`
	// Denotes the time till when the resource is available in a day in ISO-8601 format.
	EndTime    time.Time   `json:"endTime"`
	Recurrence *Recurrence `json:"recurrence,omitempty"`
	// Signifies the capacity of a resource which is available.
	Capacity int32 `json:"capacity,omitempty"`
}

`AvailabilityRecord` to represent the capacity of a resource over a time range.

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Buyer ¶

type Buyer struct {
	// The identifier of the buyer.
	BuyerId string `json:"buyerId,omitempty"`
	// The name of the buyer.
	Name string `json:"name,omitempty"`
	// The phone number of the buyer.
	Phone string `json:"phone,omitempty"`
	// When true, the service is for an Amazon Prime buyer.
	IsPrimeMember bool `json:"isPrimeMember,omitempty"`
}

Information about the buyer.

type CancelReservationResponse ¶

type CancelReservationResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

Response schema for the `cancelReservation` operation.

type CancelServiceJobByServiceJobIdResponse ¶

type CancelServiceJobByServiceJobIdResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

Response schema for the `cancelServiceJobByServiceJobId` operation.

type CapacityType ¶

type CapacityType string

CapacityType : Type of capacity

const (
	SCHEDULED_CAPACITY_CapacityType  CapacityType = "SCHEDULED_CAPACITY"
	AVAILABLE_CAPACITY_CapacityType  CapacityType = "AVAILABLE_CAPACITY"
	ENCUMBERED_CAPACITY_CapacityType CapacityType = "ENCUMBERED_CAPACITY"
	RESERVED_CAPACITY_CapacityType   CapacityType = "RESERVED_CAPACITY"
)

List of CapacityType

type CompleteServiceJobByServiceJobIdResponse ¶

type CompleteServiceJobByServiceJobIdResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

Response schema for the `completeServiceJobByServiceJobId` operation.

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateReservationRecord ¶

type CreateReservationRecord struct {
	Reservation *Reservation  `json:"reservation,omitempty"`
	Warnings    *[]Warning    `json:"warnings,omitempty"`
	Errors      *[]ModelError `json:"errors,omitempty"`
}

`CreateReservationRecord` entity contains the `Reservation` if there is an error/warning while performing the requested operation on it, otherwise it will contain the new `reservationId`.

type CreateReservationRequest ¶

type CreateReservationRequest struct {
	// Resource (store) identifier.
	ResourceId  string       `json:"resourceId"`
	Reservation *Reservation `json:"reservation"`
}

Request schema for the `createReservation` operation.

type CreateReservationResponse ¶

type CreateReservationResponse struct {
	Payload *CreateReservationRecord `json:"payload,omitempty"`
	Errors  *[]ModelError            `json:"errors,omitempty"`
}

Response schema for the `createReservation` operation.

type CreateServiceDocumentUploadDestination ¶

type CreateServiceDocumentUploadDestination struct {
	Payload *ServiceDocumentUploadDestination `json:"payload,omitempty"`
	Errors  *[]ModelError                     `json:"errors,omitempty"`
}

The response schema for the `createServiceDocumentUploadDestination` operation.

type DayOfWeek ¶

type DayOfWeek string

DayOfWeek : The day of the week.

const (
	MONDAY_DayOfWeek    DayOfWeek = "MONDAY"
	TUESDAY_DayOfWeek   DayOfWeek = "TUESDAY"
	WEDNESDAY_DayOfWeek DayOfWeek = "WEDNESDAY"
	THURSDAY_DayOfWeek  DayOfWeek = "THURSDAY"
	FRIDAY_DayOfWeek    DayOfWeek = "FRIDAY"
	SATURDAY_DayOfWeek  DayOfWeek = "SATURDAY"
	SUNDAY_DayOfWeek    DayOfWeek = "SUNDAY"
)

List of DayOfWeek

type EncryptionDetails ¶

type EncryptionDetails struct {
	// The encryption standard required to encrypt or decrypt the document contents.
	Standard string `json:"standard"`
	// The vector to encrypt or decrypt the document contents using Cipher Block Chaining (CBC).
	InitializationVector string `json:"initializationVector"`
	// The encryption key used to encrypt or decrypt the document contents.
	Key string `json:"key"`
}

Encryption details for required client-side encryption and decryption of document contents.

type FixedSlot ¶

type FixedSlot struct {
	// Start date time of slot in ISO 8601 format with precision of seconds.
	StartDateTime time.Time `json:"startDateTime,omitempty"`
	// Scheduled capacity corresponding to the slot. This capacity represents the originally allocated capacity as per resource schedule.
	ScheduledCapacity int32 `json:"scheduledCapacity,omitempty"`
	// Available capacity corresponding to the slot. This capacity represents the capacity available for allocation to reservations.
	AvailableCapacity int32 `json:"availableCapacity,omitempty"`
	// Encumbered capacity corresponding to the slot. This capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.
	EncumberedCapacity int32 `json:"encumberedCapacity,omitempty"`
	// Reserved capacity corresponding to the slot. This capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.
	ReservedCapacity int32 `json:"reservedCapacity,omitempty"`
}

In this slot format each slot only has the requested capacity types. This slot size is as specified by slot duration.

type FixedSlotCapacity ¶

type FixedSlotCapacity struct {
	// Resource Identifier.
	ResourceId string `json:"resourceId,omitempty"`
	// The duration of each slot which is returned. This value will be a multiple of 5 and fall in the following range: 5 <= `slotDuration` <= 360.
	SlotDuration float64 `json:"slotDuration,omitempty"`
	// Array of capacity slots in fixed slot format.
	Capacities []FixedSlot `json:"capacities,omitempty"`
	// Next page token, if there are more pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

Response schema for the `getFixedSlotCapacity` operation.

type FixedSlotCapacityErrors ¶

type FixedSlotCapacityErrors struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The error response schema for the `getFixedSlotCapacity` operation.

type FixedSlotCapacityQuery ¶

type FixedSlotCapacityQuery struct {
	// An array of capacity types which are being requested. Default value is `[SCHEDULED_CAPACITY]`.
	CapacityTypes []CapacityType `json:"capacityTypes,omitempty"`
	// Size in which slots are being requested. This value should be a multiple of 5 and fall in the range: 5 <= `slotDuration` <= 360.
	SlotDuration float64 `json:"slotDuration,omitempty"`
	// Start date time from which the capacity slots are being requested in ISO 8601 format.
	StartDateTime time.Time `json:"startDateTime"`
	// End date time up to which the capacity slots are being requested in ISO 8601 format.
	EndDateTime time.Time `json:"endDateTime"`
}

Request schema for the `getFixedSlotCapacity` operation. This schema is used to define the time range, capacity types and slot duration which are being queried.

type FulfillmentDocument ¶

type FulfillmentDocument struct {
	// The identifier of the upload destination. Get this value by calling the `createServiceDocumentUploadDestination` operation of the Services API.
	UploadDestinationId string `json:"uploadDestinationId,omitempty"`
	// Sha256 hash of the file content. This value is used to determine if the file has been corrupted or tampered with during transit.
	ContentSha256 string `json:"contentSha256,omitempty"`
}

Document that captured during service appointment fulfillment that portrays proof of completion

type FulfillmentTime ¶

type FulfillmentTime struct {
	// The date, time in UTC of the fulfillment start time in ISO 8601 format.
	StartTime time.Time `json:"startTime,omitempty"`
	// The date, time in UTC of the fulfillment end time in ISO 8601 format.
	EndTime time.Time `json:"endTime,omitempty"`
}

Input for fulfillment time details

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetAppointmentSlotsResponse ¶

type GetAppointmentSlotsResponse struct {
	Payload *AppointmentSlotReport `json:"payload,omitempty"`
	Errors  *[]ModelError          `json:"errors,omitempty"`
}

The response of fetching appointment slots based on service context.

type GetServiceJobByServiceJobIdResponse ¶

type GetServiceJobByServiceJobIdResponse struct {
	Payload *ServiceJob   `json:"payload,omitempty"`
	Errors  *[]ModelError `json:"errors,omitempty"`
}

The response schema for the `getServiceJobByServiceJobId` operation.

type GetServiceJobsResponse ¶

type GetServiceJobsResponse struct {
	Payload *JobListing   `json:"payload,omitempty"`
	Errors  *[]ModelError `json:"errors,omitempty"`
}

Response schema for the `getServiceJobs` operation.

type ItemDelivery ¶

type ItemDelivery struct {
	// The date and time of the latest Estimated Delivery Date (EDD) of all the items with an EDD. In ISO 8601 format.
	EstimatedDeliveryDate time.Time            `json:"estimatedDeliveryDate,omitempty"`
	ItemDeliveryPromise   *ItemDeliveryPromise `json:"itemDeliveryPromise,omitempty"`
}

Delivery information for the item.

type ItemDeliveryPromise ¶

type ItemDeliveryPromise struct {
	// The date and time of the start of the promised delivery window in ISO 8601 format.
	StartTime time.Time `json:"startTime,omitempty"`
	// The date and time of the end of the promised delivery window in ISO 8601 format.
	EndTime time.Time `json:"endTime,omitempty"`
}

Promised delivery information for the item.

type JobListing ¶

type JobListing struct {
	// Total result size of the query result.
	TotalResultSize int32 `json:"totalResultSize,omitempty"`
	// A generated string used to pass information to your next request. If `nextPageToken` is returned, pass the value of `nextPageToken` to the `pageToken` to get next results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// A generated string used to pass information to your next request. If `previousPageToken` is returned, pass the value of `previousPageToken` to the `pageToken` to get previous page results.
	PreviousPageToken string `json:"previousPageToken,omitempty"`
	// List of job details for the given input.
	Jobs []ServiceJob `json:"jobs,omitempty"`
}

The payload for the `getServiceJobs` operation.

type ModelError ¶

type ModelError struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition in a human-readable form.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`
	// The type of error.
	ErrorLevel string `json:"errorLevel,omitempty"`
}

Error response returned when the request is unsuccessful.

type Poa ¶

type Poa struct {
	AppointmentTime *AppointmentTime `json:"appointmentTime,omitempty"`
	// A list of technicians.
	Technicians []Technician `json:"technicians,omitempty"`
	// The identifier of the technician who uploaded the POA.
	UploadingTechnician string `json:"uploadingTechnician,omitempty"`
	// The date and time when the POA was uploaded in ISO 8601 format.
	UploadTime time.Time `json:"uploadTime,omitempty"`
	// The type of POA uploaded.
	PoaType string `json:"poaType,omitempty"`
}

Proof of Appointment (POA) details.

type RangeCapacity ¶

type RangeCapacity struct {
	CapacityType *CapacityType `json:"capacityType,omitempty"`
	// Array of capacity slots in range slot format.
	Slots []RangeSlot `json:"slots,omitempty"`
}

Range capacity entity where each entry has a capacity type and corresponding slots.

type RangeSlot ¶

type RangeSlot struct {
	// Start date time of slot in ISO 8601 format with precision of seconds.
	StartDateTime time.Time `json:"startDateTime,omitempty"`
	// End date time of slot in ISO 8601 format with precision of seconds.
	EndDateTime time.Time `json:"endDateTime,omitempty"`
	// Capacity of the slot.
	Capacity int32 `json:"capacity,omitempty"`
}

Capacity slots represented in a format similar to availability rules.

type RangeSlotCapacity ¶

type RangeSlotCapacity struct {
	// Resource Identifier.
	ResourceId string `json:"resourceId,omitempty"`
	// Array of range capacities where each entry is for a specific capacity type.
	Capacities []RangeCapacity `json:"capacities,omitempty"`
	// Next page token, if there are more pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

Response schema for the `getRangeSlotCapacity` operation.

type RangeSlotCapacityErrors ¶

type RangeSlotCapacityErrors struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The error response schema for the `getRangeSlotCapacity` operation.

type RangeSlotCapacityQuery ¶

type RangeSlotCapacityQuery struct {
	// An array of capacity types which are being requested. Default value is `[SCHEDULED_CAPACITY]`.
	CapacityTypes []CapacityType `json:"capacityTypes,omitempty"`
	// Start date time from which the capacity slots are being requested in ISO 8601 format.
	StartDateTime time.Time `json:"startDateTime"`
	// End date time up to which the capacity slots are being requested in ISO 8601 format.
	EndDateTime time.Time `json:"endDateTime"`
}

Request schema for the `getRangeSlotCapacity` operation. This schema is used to define the time range and capacity types that are being queried.

type Recurrence ¶

type Recurrence struct {
	// End time of the recurrence.
	EndTime time.Time `json:"endTime"`
	// Days of the week when recurrence is valid. If the schedule is valid every Monday, input will only contain `MONDAY` in the list.
	DaysOfWeek []DayOfWeek `json:"daysOfWeek,omitempty"`
	// Days of the month when recurrence is valid.
	DaysOfMonth []int32 `json:"daysOfMonth,omitempty"`
}

Repeated occurrence of an event in a time range.

type RescheduleAppointmentRequest ¶

type RescheduleAppointmentRequest struct {
	AppointmentTime      *AppointmentTimeInput `json:"appointmentTime"`
	RescheduleReasonCode string                `json:"rescheduleReasonCode"`
}

Input for rescheduled appointment operation.

type Reservation ¶

type Reservation struct {
	// Unique identifier for a reservation. If present, it is treated as an update reservation request and will update the corresponding reservation. Otherwise, it is treated as a new create reservation request.
	ReservationId string `json:"reservationId,omitempty"`
	// Type of reservation.
	Type_        string              `json:"type"`
	Availability *AvailabilityRecord `json:"availability"`
}

Reservation object reduces the capacity of a resource.

type ScopeOfWork ¶

type ScopeOfWork struct {
	// The Amazon Standard Identification Number (ASIN) of the service job.
	Asin string `json:"asin,omitempty"`
	// The title of the service job.
	Title string `json:"title,omitempty"`
	// The number of service jobs.
	Quantity int32 `json:"quantity,omitempty"`
	// A list of skills required to perform the job.
	RequiredSkills []string `json:"requiredSkills,omitempty"`
}

The scope of work for the order.

type Seller ¶

type Seller struct {
	// The identifier of the seller of the service job.
	SellerId string `json:"sellerId,omitempty"`
}

Information about the seller of the service job.

type ServiceApiGetAppointmentSlotsOpts ¶

type ServiceApiGetAppointmentSlotsOpts struct {
	StartTime optional.String
	EndTime   optional.String
}

type ServiceApiGetAppointmmentSlotsByJobIdOpts ¶

type ServiceApiGetAppointmmentSlotsByJobIdOpts struct {
	StartTime optional.String
	EndTime   optional.String
}

type ServiceApiGetFixedSlotCapacityOpts ¶

type ServiceApiGetFixedSlotCapacityOpts struct {
	NextPageToken optional.String
}

type ServiceApiGetRangeSlotCapacityOpts ¶

type ServiceApiGetRangeSlotCapacityOpts struct {
	NextPageToken optional.String
}

type ServiceApiGetServiceJobsOpts ¶

type ServiceApiGetServiceJobsOpts struct {
	ServiceOrderIds   optional.Interface
	ServiceJobStatus  optional.Interface
	PageToken         optional.String
	PageSize          optional.Int32
	SortField         optional.String
	SortOrder         optional.String
	CreatedAfter      optional.String
	CreatedBefore     optional.String
	LastUpdatedAfter  optional.String
	LastUpdatedBefore optional.String
	ScheduleStartDate optional.String
	ScheduleEndDate   optional.String
	Asins             optional.Interface
	RequiredSkills    optional.Interface
	StoreIds          optional.Interface
}

type ServiceApiService ¶

type ServiceApiService service

func (*ServiceApiService) AddAppointmentForServiceJobByServiceJobId ¶

func (a *ServiceApiService) AddAppointmentForServiceJobByServiceJobId(ctx context.Context, body AddAppointmentRequest, serviceJobId string) (SetAppointmentResponse, *http.Response, error)

ServiceApiService Adds an appointment to the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Add appointment operation input details.
@param serviceJobId An Amazon defined service job identifier.

@return SetAppointmentResponse

func (*ServiceApiService) AssignAppointmentResources ¶

func (a *ServiceApiService) AssignAppointmentResources(ctx context.Context, body AssignAppointmentResourcesRequest, serviceJobId string, appointmentId string) (AssignAppointmentResourcesResponse, *http.Response, error)

ServiceApiService Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
@param appointmentId An Amazon-defined identifier of active service job appointment.

@return AssignAppointmentResourcesResponse

func (*ServiceApiService) CancelReservation ¶

func (a *ServiceApiService) CancelReservation(ctx context.Context, reservationId string, marketplaceIds []string) (CancelReservationResponse, *http.Response, error)

ServiceApiService Cancel a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param reservationId Reservation Identifier
@param marketplaceIds An identifier for the marketplace in which the resource operates.

@return CancelReservationResponse

func (*ServiceApiService) CancelServiceJobByServiceJobId ¶

func (a *ServiceApiService) CancelServiceJobByServiceJobId(ctx context.Context, serviceJobId string, cancellationReasonCode string) (CancelServiceJobByServiceJobIdResponse, *http.Response, error)

ServiceApiService Cancels the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param serviceJobId An Amazon defined service job identifier.
@param cancellationReasonCode A cancel reason code that specifies the reason for cancelling a service job.

@return CancelServiceJobByServiceJobIdResponse

func (*ServiceApiService) CompleteServiceJobByServiceJobId ¶

func (a *ServiceApiService) CompleteServiceJobByServiceJobId(ctx context.Context, serviceJobId string) (CompleteServiceJobByServiceJobIdResponse, *http.Response, error)

ServiceApiService Completes the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param serviceJobId An Amazon defined service job identifier.

@return CompleteServiceJobByServiceJobIdResponse

func (*ServiceApiService) CreateReservation ¶

func (a *ServiceApiService) CreateReservation(ctx context.Context, body CreateReservationRequest, marketplaceIds []string) (CreateReservationResponse, *http.Response, error)

ServiceApiService Create a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Reservation details
@param marketplaceIds An identifier for the marketplace in which the resource operates.

@return CreateReservationResponse

func (*ServiceApiService) CreateServiceDocumentUploadDestination ¶

func (a *ServiceApiService) CreateServiceDocumentUploadDestination(ctx context.Context, body ServiceUploadDocument) (CreateServiceDocumentUploadDestination, *http.Response, error)

ServiceApiService Creates an upload destination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Upload document operation input details.

@return CreateServiceDocumentUploadDestination

func (*ServiceApiService) GetAppointmentSlots ¶

func (a *ServiceApiService) GetAppointmentSlots(ctx context.Context, asin string, storeId string, marketplaceIds []string, localVarOptionals *ServiceApiGetAppointmentSlotsOpts) (GetAppointmentSlotsResponse, *http.Response, error)

func (*ServiceApiService) GetAppointmmentSlotsByJobId ¶

func (a *ServiceApiService) GetAppointmmentSlotsByJobId(ctx context.Context, serviceJobId string, marketplaceIds []string, localVarOptionals *ServiceApiGetAppointmmentSlotsByJobIdOpts) (GetAppointmentSlotsResponse, *http.Response, error)

func (*ServiceApiService) GetFixedSlotCapacity ¶

func (a *ServiceApiService) GetFixedSlotCapacity(ctx context.Context, body FixedSlotCapacityQuery, marketplaceIds []string, resourceId string, localVarOptionals *ServiceApiGetFixedSlotCapacityOpts) (FixedSlotCapacity, *http.Response, error)

func (*ServiceApiService) GetRangeSlotCapacity ¶

func (a *ServiceApiService) GetRangeSlotCapacity(ctx context.Context, body RangeSlotCapacityQuery, marketplaceIds []string, resourceId string, localVarOptionals *ServiceApiGetRangeSlotCapacityOpts) (RangeSlotCapacity, *http.Response, error)

func (*ServiceApiService) GetServiceJobByServiceJobId ¶

func (a *ServiceApiService) GetServiceJobByServiceJobId(ctx context.Context, serviceJobId string) (GetServiceJobByServiceJobIdResponse, *http.Response, error)

ServiceApiService Gets details of service job indicated by the provided `serviceJobID`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 20 | 40 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param serviceJobId A service job identifier.

@return GetServiceJobByServiceJobIdResponse

func (*ServiceApiService) GetServiceJobs ¶

func (a *ServiceApiService) GetServiceJobs(ctx context.Context, marketplaceIds []string, localVarOptionals *ServiceApiGetServiceJobsOpts) (GetServiceJobsResponse, *http.Response, error)

func (*ServiceApiService) RescheduleAppointmentForServiceJobByServiceJobId ¶

func (a *ServiceApiService) RescheduleAppointmentForServiceJobByServiceJobId(ctx context.Context, body RescheduleAppointmentRequest, serviceJobId string, appointmentId string) (SetAppointmentResponse, *http.Response, error)

ServiceApiService Reschedules an appointment for the service job indicated by the service job identifier specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Reschedule appointment operation input details.
@param serviceJobId An Amazon defined service job identifier.
@param appointmentId An existing appointment identifier for the Service Job.

@return SetAppointmentResponse

func (*ServiceApiService) SetAppointmentFulfillmentData ¶

func (a *ServiceApiService) SetAppointmentFulfillmentData(ctx context.Context, body SetAppointmentFulfillmentDataRequest, serviceJobId string, appointmentId string) (string, *http.Response, error)

ServiceApiService Updates the appointment fulfillment data related to a given `jobID` and `appointmentID`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Appointment fulfillment data collection details.
@param serviceJobId An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.
@param appointmentId An Amazon-defined identifier of active service job appointment.

@return string

func (*ServiceApiService) UpdateReservation ¶

func (a *ServiceApiService) UpdateReservation(ctx context.Context, body UpdateReservationRequest, marketplaceIds []string, reservationId string) (UpdateReservationResponse, *http.Response, error)

ServiceApiService Update a reservation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Reservation details
@param marketplaceIds An identifier for the marketplace in which the resource operates.
@param reservationId Reservation Identifier

@return UpdateReservationResponse

func (*ServiceApiService) UpdateSchedule ¶

func (a *ServiceApiService) UpdateSchedule(ctx context.Context, body UpdateScheduleRequest, marketplaceIds []string, resourceId string) (UpdateScheduleResponse, *http.Response, error)

ServiceApiService Update the schedule of the given resource. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Schedule details
@param marketplaceIds An identifier for the marketplace in which the resource operates.
@param resourceId Resource (store) Identifier

@return UpdateScheduleResponse

type ServiceDocumentUploadDestination ¶

type ServiceDocumentUploadDestination struct {
	// The unique identifier to be used by APIs that reference the upload destination.
	UploadDestinationId string `json:"uploadDestinationId"`
	// The URL to which to upload the file.
	Url               string             `json:"url"`
	EncryptionDetails *EncryptionDetails `json:"encryptionDetails"`
	// The headers to include in the upload request.
	Headers *interface{} `json:"headers,omitempty"`
}

Information about an upload destination.

type ServiceJob ¶

type ServiceJob struct {
	// The date and time of the creation of the job in ISO 8601 format.
	CreateTime   time.Time `json:"createTime,omitempty"`
	ServiceJobId string    `json:"serviceJobId,omitempty"`
	// The status of the service job.
	ServiceJobStatus   string              `json:"serviceJobStatus,omitempty"`
	ScopeOfWork        *ScopeOfWork        `json:"scopeOfWork,omitempty"`
	Seller             *Seller             `json:"seller,omitempty"`
	ServiceJobProvider *ServiceJobProvider `json:"serviceJobProvider,omitempty"`
	// A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order.
	PreferredAppointmentTimes []AppointmentTime `json:"preferredAppointmentTimes,omitempty"`
	// A list of appointments.
	Appointments   []Appointment `json:"appointments,omitempty"`
	ServiceOrderId string        `json:"serviceOrderId,omitempty"`
	// The marketplace identifier.
	MarketplaceId string `json:"marketplaceId,omitempty"`
	// The Amazon-defined identifier for the region scope.
	StoreId string `json:"storeId,omitempty"`
	Buyer   *Buyer `json:"buyer,omitempty"`
	// A list of items associated with the service job.
	AssociatedItems []AssociatedItem `json:"associatedItems,omitempty"`
	ServiceLocation *ServiceLocation `json:"serviceLocation,omitempty"`
}

The job details of a service.

type ServiceJobProvider ¶

type ServiceJobProvider struct {
	// The identifier of the service job provider.
	ServiceJobProviderId string `json:"serviceJobProviderId,omitempty"`
}

Information about the service job provider.

type ServiceLocation ¶

type ServiceLocation struct {
	// The location of the service job.
	ServiceLocationType string   `json:"serviceLocationType,omitempty"`
	Address             *Address `json:"address,omitempty"`
}

Information about the location of the service job.

type ServiceUploadDocument ¶

type ServiceUploadDocument struct {
	// The content type of the to-be-uploaded file
	ContentType string `json:"contentType"`
	// The content length of the to-be-uploaded file
	ContentLength float64 `json:"contentLength"`
	// An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit.
	ContentMD5 string `json:"contentMD5,omitempty"`
}

Input for to be uploaded document.

type SetAppointmentFulfillmentDataRequest ¶

type SetAppointmentFulfillmentDataRequest struct {
	FulfillmentTime      *FulfillmentTime       `json:"fulfillmentTime,omitempty"`
	AppointmentResources *[]AppointmentResource `json:"appointmentResources,omitempty"`
	FulfillmentDocuments *[]FulfillmentDocument `json:"fulfillmentDocuments,omitempty"`
}

Input for set appointment fulfillment data operation.

type SetAppointmentResponse ¶

type SetAppointmentResponse struct {
	AppointmentId string        `json:"appointmentId,omitempty"`
	Warnings      *[]Warning    `json:"warnings,omitempty"`
	Errors        *[]ModelError `json:"errors,omitempty"`
}

Response schema for the `addAppointmentForServiceJobByServiceJobId` and `rescheduleAppointmentForServiceJobByServiceJobId` operations.

type Technician ¶

type Technician struct {
	// The technician identifier.
	TechnicianId string `json:"technicianId,omitempty"`
	// The name of the technician.
	Name string `json:"name,omitempty"`
}

A technician who is assigned to perform the service job in part or in full.

type UpdateReservationRecord ¶

type UpdateReservationRecord struct {
	Reservation *Reservation  `json:"reservation,omitempty"`
	Warnings    *[]Warning    `json:"warnings,omitempty"`
	Errors      *[]ModelError `json:"errors,omitempty"`
}

`UpdateReservationRecord` entity contains the `Reservation` if there is an error/warning while performing the requested operation on it, otherwise it will contain the new `reservationId`.

type UpdateReservationRequest ¶

type UpdateReservationRequest struct {
	// Resource (store) identifier.
	ResourceId  string       `json:"resourceId"`
	Reservation *Reservation `json:"reservation"`
}

Request schema for the `updateReservation` operation.

type UpdateReservationResponse ¶

type UpdateReservationResponse struct {
	Payload *UpdateReservationRecord `json:"payload,omitempty"`
	Errors  *[]ModelError            `json:"errors,omitempty"`
}

Response schema for the `updateReservation` operation.

type UpdateScheduleRecord ¶

type UpdateScheduleRecord struct {
	Availability *AvailabilityRecord `json:"availability,omitempty"`
	Warnings     *[]Warning          `json:"warnings,omitempty"`
	Errors       *[]ModelError       `json:"errors,omitempty"`
}

`UpdateScheduleRecord` entity contains the `AvailabilityRecord` if there is an error/warning while performing the requested operation on it.

type UpdateScheduleRequest ¶

type UpdateScheduleRequest struct {
	Schedules *[]AvailabilityRecord `json:"schedules"`
}

Request schema for the `updateSchedule` operation.

type UpdateScheduleResponse ¶

type UpdateScheduleResponse struct {
	// Contains the `UpdateScheduleRecords` for which the error/warning has occurred.
	Payload []UpdateScheduleRecord `json:"payload,omitempty"`
	Errors  *[]ModelError          `json:"errors,omitempty"`
}

Response schema for the `updateSchedule` operation.

type Warning ¶

type Warning struct {
	// An warning code that identifies the type of warning that occurred.
	Code string `json:"code"`
	// A message that describes the warning condition in a human-readable form.
	Message string `json:"message"`
	// Additional details that can help the caller understand or address the warning.
	Details string `json:"details,omitempty"`
}

Warning returned when the request is successful, but there are important callouts based on which API clients should take defined actions.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL