Documentation
¶
Overview ¶
Package orders20260101 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.
Index ¶
- func NewGetOrderRequest(server string, orderId string, params *GetOrderParams) (*http.Request, error)
- func NewSearchOrdersRequest(server string, params *SearchOrdersParams) (*http.Request, error)
- type AddressExtendedFields
- type Alias
- type Asin
- type AssociatedOrder
- type BusinessHour
- type BusinessHourDayOfWeek
- type Buyer
- type Client
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- type ClientWithResponsesInterface
- type ConstraintType
- type CustomerAddress
- type DateTimeRange
- type Decimal
- type DeliveryPreference
- type Error
- type ErrorList
- type ExceptionDate
- type ExceptionDateExceptionDateType
- type FulfillmentStatus
- type GetOrderParams
- type GetOrderParamsIncludedData
- type GetOrderResp
- type GetOrderResponse
- type GiftOption
- type HourMinute
- type HttpRequestDoer
- type ItemCancellation
- type ItemCancellationRequest
- type ItemCondition
- type ItemCustomization
- type ItemExpense
- type ItemFulfillment
- type ItemInternationalShipping
- type ItemPacking
- type ItemPicking
- type ItemPointsCost
- type ItemPrice
- type ItemProceeds
- type ItemProceedsBreakdown
- type ItemProceedsDetailedBreakdown
- type ItemProduct
- type ItemPromotion
- type ItemPromotionBreakdown
- type ItemShipping
- type ItemShippingConstraints
- type ItemSubstitutionOption
- type ItemSubstitutionPreference
- type ItemSubstitutionPreferenceSubstitutionType
- type Measurement
- type MeasurementUnit
- type MerchantAddress
- type Money
- type Order
- type OrderFulfillment
- type OrderItem
- type OrderPackage
- type OrderProceeds
- type PackageItem
- type PackageStatus
- type PackageStatusStatus
- type Pagination
- type PointsGranted
- type PreferredDeliveryCapability
- type PreferredDeliveryTime
- type Recipient
- type RequestEditorFn
- type ResponseEditorFn
- type SKU
- type SalesChannel
- type SearchOrdersParams
- type SearchOrdersParamsFulfilledBy
- type SearchOrdersParamsFulfillmentStatuses
- type SearchOrdersParamsIncludedData
- type SearchOrdersResp
- type SearchOrdersResponse
- type TimeWindow
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewGetOrderRequest ¶
func NewGetOrderRequest(server string, orderId string, params *GetOrderParams) (*http.Request, error)
NewGetOrderRequest generates requests for GetOrder
func NewSearchOrdersRequest ¶
func NewSearchOrdersRequest(server string, params *SearchOrdersParams) (*http.Request, error)
NewSearchOrdersRequest generates requests for SearchOrders
Types ¶
type AddressExtendedFields ¶
type AddressExtendedFields struct {
// Complement The floor number / unit number.
Complement *string `json:"complement,omitempty"`
// Neighborhood The neighborhood. This value is only used in some countries (such as Brazil).
Neighborhood *string `json:"neighborhood,omitempty"`
// StreetName The name of the street.
StreetName *string `json:"streetName,omitempty"`
// StreetNumber The house, building, or property number associated with the location's street address.
StreetNumber *string `json:"streetNumber,omitempty"`
}
AddressExtendedFields Additional address components that provide more detailed location information, helping with precise delivery routing.
**Note**: Only available with Brazil shipping addresses.
type Alias ¶
type Alias struct {
// AliasId The alternative identifier value that can be used to reference this order.
AliasId string `json:"aliasId"`
// AliasType The kind of alternative identifier this represents.
//
// **Possible values**: `SELLER_ORDER_ID`
AliasType string `json:"aliasType"`
}
Alias An alternative identifier that provides a different way to reference the same order.
type Asin ¶
type Asin = string
Asin The Amazon Standard Identification Number (ASIN), which uniquely identifies a product (catalog item).
type AssociatedOrder ¶
type AssociatedOrder struct {
// AssociationType The relationship between the current order and the associated order.
//
// **Possible values**: `REPLACEMENT_ORIGINAL_ID`, `EXCHANGE_ORIGINAL_ID`
AssociationType *string `json:"associationType,omitempty"`
// OrderId The unique identifier of the related order that is associated with the current order.
OrderId *string `json:"orderId,omitempty"`
}
AssociatedOrder Another order that has a direct business relationship with the current order, such as replacements or exchanges.
type BusinessHour ¶
type BusinessHour struct {
// DayOfWeek Specific day of the week for which operating hours are being defined.
DayOfWeek *BusinessHourDayOfWeek `json:"dayOfWeek,omitempty"`
// TimeWindows Collection of time windows during which the location is available for deliveries on the specified day.
TimeWindows *[]TimeWindow `json:"timeWindows,omitempty"`
}
BusinessHour Business days and hours when the destination is open for deliveries.
type BusinessHourDayOfWeek ¶
type BusinessHourDayOfWeek string
BusinessHourDayOfWeek Specific day of the week for which operating hours are being defined.
const ( FRI BusinessHourDayOfWeek = "FRI" MON BusinessHourDayOfWeek = "MON" SAT BusinessHourDayOfWeek = "SAT" SUN BusinessHourDayOfWeek = "SUN" THU BusinessHourDayOfWeek = "THU" TUE BusinessHourDayOfWeek = "TUE" WED BusinessHourDayOfWeek = "WED" )
Defines values for BusinessHourDayOfWeek.
type Buyer ¶
type Buyer struct {
// BuyerCompanyName The name of the company or organization for a business order.
BuyerCompanyName *string `json:"buyerCompanyName,omitempty"`
// BuyerEmail The anonymized email address of the buyer. **Note:** Only available for merchant-fulfilled (FBM) orders.
BuyerEmail *string `json:"buyerEmail,omitempty"`
// BuyerName The full name of the customer who placed the order.
BuyerName *string `json:"buyerName,omitempty"`
// BuyerPurchaseOrderNumber The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
BuyerPurchaseOrderNumber *string `json:"buyerPurchaseOrderNumber,omitempty"`
}
Buyer Information about the customer who purchased the order.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
// A callback for modifying response which are generated after receive from the network.
ResponseEditors []ResponseEditorFn
// The user agent header identifies your application, its version number, and the platform and programming language you are using.
// You must include a user agent header in each request submitted to the sales partner API.
UserAgent string
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) SearchOrders ¶
type ClientInterface ¶
type ClientInterface interface {
// SearchOrders request
SearchOrders(ctx context.Context, params *SearchOrdersParams) (*http.Response, error)
// GetOrder request
GetOrder(ctx context.Context, orderId string, params *GetOrderParams) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
func WithResponseEditorFn ¶
func WithResponseEditorFn(fn ResponseEditorFn) ClientOption
WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetOrderWithResponse ¶
func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, orderId string, params *GetOrderParams) (*GetOrderResp, error)
GetOrderWithResponse request returning *GetOrderResp
func (*ClientWithResponses) SearchOrdersWithResponse ¶
func (c *ClientWithResponses) SearchOrdersWithResponse(ctx context.Context, params *SearchOrdersParams) (*SearchOrdersResp, error)
SearchOrdersWithResponse request returning *SearchOrdersResp
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// SearchOrdersWithResponse request
SearchOrdersWithResponse(ctx context.Context, params *SearchOrdersParams) (*SearchOrdersResp, error)
// GetOrderWithResponse request
GetOrderWithResponse(ctx context.Context, orderId string, params *GetOrderParams) (*GetOrderResp, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type ConstraintType ¶
type ConstraintType string
ConstraintType Classification of the enforcement level required for shipping and delivery constraints.
const (
MANDATORY ConstraintType = "MANDATORY"
)
Defines values for ConstraintType.
type CustomerAddress ¶
type CustomerAddress struct {
// AddressLine1 The primary street address.
AddressLine1 *string `json:"addressLine1,omitempty"`
// AddressLine2 Additional address information.
AddressLine2 *string `json:"addressLine2,omitempty"`
// AddressLine3 Additional address information.
AddressLine3 *string `json:"addressLine3,omitempty"`
// AddressType The type of location.
//
// **Possible values**: `RESIDENTIAL`, `COMMERCIAL`, `PICKUP_POINT`
AddressType *string `json:"addressType,omitempty"`
// City The city of the address.
City *string `json:"city,omitempty"`
// CompanyName The name of the business or organization at this address.
CompanyName *string `json:"companyName,omitempty"`
// CountryCode The two-letter country code identifying the country of the address, in ISO 3166-1 format.
CountryCode *string `json:"countryCode,omitempty"`
// DistrictOrCounty The district or county of the address.
DistrictOrCounty *string `json:"districtOrCounty,omitempty"`
// ExtendedFields Additional address components that provide more detailed location information, helping with precise delivery routing.
//
// **Note**: Only available with Brazil shipping addresses.
ExtendedFields *AddressExtendedFields `json:"extendedFields,omitempty"`
// Municipality The municipality of the address.
Municipality *string `json:"municipality,omitempty"`
// Name The full name of the person who will receive the delivery at this address.
Name *string `json:"name,omitempty"`
// Phone The contact phone number for delivery coordination and customer communication.
//
// **Note**: The buyer phone number will be suppressed in some cases, including but not limited to:
//
// - All FBA (Fulfillment by Amazon) orders.
// - Shipped FBM (Fulfilled by the merchant) orders when current date is past the latest delivery date.
Phone *string `json:"phone,omitempty"`
// PostalCode The postal code, ZIP code, or equivalent mailing code of the address.
PostalCode *string `json:"postalCode,omitempty"`
// StateOrRegion The state, province, or region of the address.
StateOrRegion *string `json:"stateOrRegion,omitempty"`
}
CustomerAddress The physical address of the customer.
type DateTimeRange ¶
type DateTimeRange struct {
// EarliestDateTime The beginning of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
EarliestDateTime *time.Time `json:"earliestDateTime,omitempty"`
// LatestDateTime The end of the time period, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
LatestDateTime *time.Time `json:"latestDateTime,omitempty"`
}
DateTimeRange A time period with start and end boundaries.
type Decimal ¶
type Decimal = string
Decimal A decimal number with no loss of precision. Follows RFC 7159 for number representation.
type DeliveryPreference ¶
type DeliveryPreference struct {
// AddressInstruction Building instructions, nearby landmark, or navigation instructions.
AddressInstruction *string `json:"addressInstruction,omitempty"`
// DeliveryCapabilities A list of miscellaneous delivery capabilities associated with the shipping address.
DeliveryCapabilities *[]PreferredDeliveryCapability `json:"deliveryCapabilities,omitempty"`
// DeliveryTime Customer-specified time preferences for when deliveries should be attempted at the destination address.
DeliveryTime *PreferredDeliveryTime `json:"deliveryTime,omitempty"`
// DropOffLocation The drop-off location selected by the customer.
DropOffLocation *string `json:"dropOffLocation,omitempty"`
}
DeliveryPreference Contains all delivery instructions that the customer provides for the shipping address.
type Error ¶
type Error struct {
// Code An error code that identifies the type of error that occurred.
Code string `json:"code"`
// Details Additional details that can help the caller understand or fix the issue.
Details *string `json:"details,omitempty"`
// Message A message that describes the error condition.
Message string `json:"message"`
}
Error Error response returned when the request is unsuccessful.
type ErrorList ¶
type ErrorList struct {
// Errors A list of errors.
Errors []Error `json:"errors"`
}
ErrorList A list of error responses returned when a request is unsuccessful.
type ExceptionDate ¶
type ExceptionDate struct {
// ExceptionDate Specific calendar date when normal operating hours do not apply. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format at day granularity.
ExceptionDate *openapi_types.Date `json:"exceptionDate,omitempty"`
// ExceptionDateType Operational status of the business on the specified exception date.
ExceptionDateType *ExceptionDateExceptionDateType `json:"exceptionDateType,omitempty"`
// TimeWindows Alternative operating hours that apply specifically to this exception date.
TimeWindows *[]TimeWindow `json:"timeWindows,omitempty"`
}
ExceptionDate Special dates when normal business hours are modified or suspended, requiring different delivery scheduling.
type ExceptionDateExceptionDateType ¶
type ExceptionDateExceptionDateType string
ExceptionDateExceptionDateType Operational status of the business on the specified exception date.
const ( CLOSED ExceptionDateExceptionDateType = "CLOSED" OPEN ExceptionDateExceptionDateType = "OPEN" )
Defines values for ExceptionDateExceptionDateType.
type FulfillmentStatus ¶
type FulfillmentStatus string
FulfillmentStatus The current fulfillment status of an order, indicating where the order is in the fulfillment process from placement to handover to carrier.
const ( FulfillmentStatusCANCELLED FulfillmentStatus = "CANCELLED" FulfillmentStatusPARTIALLYSHIPPED FulfillmentStatus = "PARTIALLY_SHIPPED" FulfillmentStatusPENDING FulfillmentStatus = "PENDING" FulfillmentStatusPENDINGAVAILABILITY FulfillmentStatus = "PENDING_AVAILABILITY" FulfillmentStatusSHIPPED FulfillmentStatus = "SHIPPED" FulfillmentStatusUNFULFILLABLE FulfillmentStatus = "UNFULFILLABLE" FulfillmentStatusUNSHIPPED FulfillmentStatus = "UNSHIPPED" )
Defines values for FulfillmentStatus.
type GetOrderParams ¶
type GetOrderParams struct {
// IncludedData A list of datasets to include in the response.
IncludedData *[]GetOrderParamsIncludedData `form:"includedData,omitempty" json:"includedData,omitempty"`
}
GetOrderParams defines parameters for GetOrder.
type GetOrderParamsIncludedData ¶
type GetOrderParamsIncludedData string
GetOrderParamsIncludedData defines parameters for GetOrder.
const ( GetOrderParamsIncludedDataBUYER GetOrderParamsIncludedData = "BUYER" GetOrderParamsIncludedDataCANCELLATION GetOrderParamsIncludedData = "CANCELLATION" GetOrderParamsIncludedDataEXPENSE GetOrderParamsIncludedData = "EXPENSE" GetOrderParamsIncludedDataFULFILLMENT GetOrderParamsIncludedData = "FULFILLMENT" GetOrderParamsIncludedDataPACKAGES GetOrderParamsIncludedData = "PACKAGES" GetOrderParamsIncludedDataPROCEEDS GetOrderParamsIncludedData = "PROCEEDS" GetOrderParamsIncludedDataPROMOTION GetOrderParamsIncludedData = "PROMOTION" GetOrderParamsIncludedDataRECIPIENT GetOrderParamsIncludedData = "RECIPIENT" )
Defines values for GetOrderParamsIncludedData.
type GetOrderResp ¶
type GetOrderResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *GetOrderResponse
JSON400 *ErrorList
JSON403 *ErrorList
JSON404 *ErrorList
JSON413 *ErrorList
JSON415 *ErrorList
JSON429 *ErrorList
JSON500 *ErrorList
JSON503 *ErrorList
}
func ParseGetOrderResp ¶
func ParseGetOrderResp(rsp *http.Response) (*GetOrderResp, error)
ParseGetOrderResp parses an HTTP response from a GetOrderWithResponse call
func (GetOrderResp) Status ¶
func (r GetOrderResp) Status() string
Status returns HTTPResponse.Status
func (GetOrderResp) StatusCode ¶
func (r GetOrderResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetOrderResponse ¶
type GetOrderResponse struct {
// Order Comprehensive information about a customer order.
Order Order `json:"order"`
}
GetOrderResponse Order details.
type GiftOption ¶
type GiftOption struct {
// GiftMessage Personal message from the buyer to be included with the gift-wrapped item.
GiftMessage *string `json:"giftMessage,omitempty"`
// GiftWrapLevel Type or quality level of gift wrapping service selected by the customer.
GiftWrapLevel *string `json:"giftWrapLevel,omitempty"`
}
GiftOption Gift wrapping and personalization options selected by the customer for an order item.
type HourMinute ¶
type HourMinute struct {
// Hour The hour when the business opens or closes, in 24-hour format (0-23).
Hour *int `json:"hour,omitempty"`
// Minute The minute when the business opens or closes.
Minute *int `json:"minute,omitempty"`
}
HourMinute The time when the business opens or closes.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type ItemCancellation ¶
type ItemCancellation struct {
// CancellationRequest Detailed information about a cancellation request submitted for a specific order item.
CancellationRequest *ItemCancellationRequest `json:"cancellationRequest,omitempty"`
}
ItemCancellation The cancellation information of the order item.
type ItemCancellationRequest ¶
type ItemCancellationRequest struct {
// CancelReason Explanation provided for why the cancellation was requested.
CancelReason *string `json:"cancelReason,omitempty"`
// Requester Entity that initiated the cancellation request for this item.
//
// **Possible values**: `BUYER`
Requester *string `json:"requester,omitempty"`
}
ItemCancellationRequest Detailed information about a cancellation request submitted for a specific order item.
type ItemCondition ¶
type ItemCondition struct {
// ConditionNote Additional details provided by the seller to describe the specific condition of this particular item.
ConditionNote *string `json:"conditionNote,omitempty"`
// ConditionSubtype A more specific condition classification that provides additional detail about the item's quality within the main condition type.
//
// **Possible values**: `NEW`, `MINT`, `VERY_GOOD`, `GOOD`, `ACCEPTABLE`, `POOR`, `CLUB`, `OEM`, `WARRANTY`, `REFURBISHED_WARRANTY`, `REFURBISHED`, `OPEN_BOX`, `ANY`, `OTHER`.
ConditionSubtype *string `json:"conditionSubtype,omitempty"`
// ConditionType The primary condition category that broadly describes the item's state.
//
// **Possible values**: `NEW`, `USED`, `COLLECTIBLE`, `REFURBISHED`, `PREORDER`, `CLUB`.
ConditionType *string `json:"conditionType,omitempty"`
}
ItemCondition Detailed information about the physical condition and quality state of the item being sold.
type ItemCustomization ¶
type ItemCustomization struct {
// CustomizedUrl The URL of the customized data for custom orders from the Amazon Custom program.
CustomizedUrl *string `json:"customizedUrl,omitempty"`
}
ItemCustomization Information about any personalization, customization, or special modifications applied to this order item.
type ItemExpense ¶
type ItemExpense struct {
// PointsCost Information about Amazon Points granted with the purchase of an item, including both quantity and monetary equivalent value.
PointsCost *ItemPointsCost `json:"pointsCost,omitempty"`
}
ItemExpense The expense information related to this specific item.
type ItemFulfillment ¶
type ItemFulfillment struct {
// Packing Information related to the packaging process for an order item.
Packing *ItemPacking `json:"packing,omitempty"`
// Picking Information related to the warehouse picking process for an order item.
Picking *ItemPicking `json:"picking,omitempty"`
// QuantityFulfilled The number of units of this item that have been successfully processed and shipped.
QuantityFulfilled *int `json:"quantityFulfilled,omitempty"`
// QuantityUnfulfilled The number of units of this item that remain to be processed and shipped.
QuantityUnfulfilled *int `json:"quantityUnfulfilled,omitempty"`
// Shipping Information related to the shipping and delivery process for an order item.
Shipping *ItemShipping `json:"shipping,omitempty"`
}
ItemFulfillment Information about how the order item should be processed, packed, and shipped to the customer.
type ItemInternationalShipping ¶
type ItemInternationalShipping struct {
// IossNumber Import One-Stop Shop registration number required for EU VAT compliance when shipping from outside the European Union. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.
IossNumber *string `json:"iossNumber,omitempty"`
}
ItemInternationalShipping Additional requirements needed for cross-border shipping of an order item.
type ItemPacking ¶
type ItemPacking struct {
// GiftOption Gift wrapping and personalization options selected by the customer for an order item.
GiftOption *GiftOption `json:"giftOption,omitempty"`
}
ItemPacking Information related to the packaging process for an order item.
type ItemPicking ¶
type ItemPicking struct {
// SubstitutionPreference Substitution preference for an order item when it becomes unavailable during fulfillment.
SubstitutionPreference *ItemSubstitutionPreference `json:"substitutionPreference,omitempty"`
}
ItemPicking Information related to the warehouse picking process for an order item.
type ItemPointsCost ¶
type ItemPointsCost struct {
// PointsGranted Information about Amazon Points awarded with an item purchase.
PointsGranted *PointsGranted `json:"pointsGranted,omitempty"`
}
ItemPointsCost Information about Amazon Points granted with the purchase of an item, including both quantity and monetary equivalent value.
type ItemPrice ¶
type ItemPrice struct {
// PriceDesignation Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business).
//
// **Possible value**: `BUSINESS_PRICE`
PriceDesignation *string `json:"priceDesignation,omitempty"`
// UnitPrice An amount of money, including units in the form of currency.
UnitPrice *Money `json:"unitPrice,omitempty"`
}
ItemPrice Pricing information for the order item.
type ItemProceeds ¶
type ItemProceeds struct {
// Breakdowns The breakdown of proceeds.
Breakdowns *[]ItemProceedsBreakdown `json:"breakdowns,omitempty"`
// ProceedsTotal An amount of money, including units in the form of currency.
ProceedsTotal *Money `json:"proceedsTotal,omitempty"`
}
ItemProceeds The money that the seller receives from the sale of this specific item.
type ItemProceedsBreakdown ¶
type ItemProceedsBreakdown struct {
// DetailedBreakdowns Further granular breakdown of the subtotal.
DetailedBreakdowns *[]ItemProceedsDetailedBreakdown `json:"detailedBreakdowns,omitempty"`
// Subtotal An amount of money, including units in the form of currency.
Subtotal *Money `json:"subtotal,omitempty"`
// Type Category classification of the proceeds breakdown.
//
// **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `TAX`, `DISCOUNT`
Type *string `json:"type,omitempty"`
}
ItemProceedsBreakdown Detailed proceeds breakdown for a specific order item.
type ItemProceedsDetailedBreakdown ¶
type ItemProceedsDetailedBreakdown struct {
// Subtype Specific classification of the further granular breakdown.
//
// **Possible values**: `ITEM`, `SHIPPING`, `GIFT_WRAP`, `COD_FEE`, `OTHER`, `DISCOUNT`
Subtype *string `json:"subtype,omitempty"`
// Value An amount of money, including units in the form of currency.
Value *Money `json:"value,omitempty"`
}
ItemProceedsDetailedBreakdown Further granular breakdown of the subtotal of the proceeds breakdown, only available for TAX and DISCOUNT proceeds type.
type ItemProduct ¶
type ItemProduct struct {
// Asin The Amazon Standard Identification Number (ASIN), which uniquely identifies a product (catalog item).
Asin *Asin `json:"asin,omitempty"`
// Condition Detailed information about the physical condition and quality state of the item being sold.
Condition *ItemCondition `json:"condition,omitempty"`
// Customization Information about any personalization, customization, or special modifications applied to this order item.
Customization *ItemCustomization `json:"customization,omitempty"`
// Price Pricing information for the order item.
Price *ItemPrice `json:"price,omitempty"`
// SellerSku The seller SKU of a product (catalog item). This is a unique number assigned by the seller when listing an item.
SellerSku *SKU `json:"sellerSku,omitempty"`
// SerialNumbers Unique serial numbers for products that require individual tracking, typically provided for FBA orders.
SerialNumbers *[]string `json:"serialNumbers,omitempty"`
// Title The product name or title as displayed to customers in the marketplace.
Title *string `json:"title,omitempty"`
}
ItemProduct Product information for an order item.
type ItemPromotion ¶
type ItemPromotion struct {
// Breakdowns A list of promotions applied to the order item.
Breakdowns *[]ItemPromotionBreakdown `json:"breakdowns,omitempty"`
}
ItemPromotion Details about any discounts, coupons, or promotional offers applied to this item.
type ItemPromotionBreakdown ¶
type ItemPromotionBreakdown struct {
// PromotionId Unique identifier for the promotion applied to this item.
PromotionId *string `json:"promotionId,omitempty"`
}
ItemPromotionBreakdown Detailed information about a specific promotional offer applied to an order item.
type ItemShipping ¶
type ItemShipping struct {
// InternationalShipping Additional requirements needed for cross-border shipping of an order item.
InternationalShipping *ItemInternationalShipping `json:"internationalShipping,omitempty"`
// ScheduledDeliveryWindow A time period with start and end boundaries.
ScheduledDeliveryWindow *DateTimeRange `json:"scheduledDeliveryWindow,omitempty"`
// ShippingConstraints Special shipping requirements and restrictions that must be observed when shipping an order item.
ShippingConstraints *ItemShippingConstraints `json:"shippingConstraints,omitempty"`
}
ItemShipping Information related to the shipping and delivery process for an order item.
type ItemShippingConstraints ¶
type ItemShippingConstraints struct {
// CashOnDelivery Classification of the enforcement level required for shipping and delivery constraints.
CashOnDelivery *ConstraintType `json:"cashOnDelivery,omitempty"`
// PalletDelivery Classification of the enforcement level required for shipping and delivery constraints.
PalletDelivery *ConstraintType `json:"palletDelivery,omitempty"`
// RecipientAgeVerification Classification of the enforcement level required for shipping and delivery constraints.
RecipientAgeVerification *ConstraintType `json:"recipientAgeVerification,omitempty"`
// RecipientIdentityVerification Classification of the enforcement level required for shipping and delivery constraints.
RecipientIdentityVerification *ConstraintType `json:"recipientIdentityVerification,omitempty"`
// SignatureConfirmation Classification of the enforcement level required for shipping and delivery constraints.
SignatureConfirmation *ConstraintType `json:"signatureConfirmation,omitempty"`
}
ItemShippingConstraints Special shipping requirements and restrictions that must be observed when shipping an order item.
type ItemSubstitutionOption ¶
type ItemSubstitutionOption struct {
// Asin Amazon Standard Identification Number of the substitute product.
Asin *string `json:"asin,omitempty"`
// Measurement Specifies the unit of measure and quantity for items that are sold by weight, volume, length, or other measurements rather than simple count.
Measurement *Measurement `json:"measurement,omitempty"`
// QuantityOrdered Number of units of the substitute item to be selected if substitution occurs.
QuantityOrdered *int `json:"quantityOrdered,omitempty"`
// SellerSku The item's seller stock keeping unit (SKU).
SellerSku *string `json:"sellerSku,omitempty"`
// Title Product name or title of the substitute item as displayed to customers.
Title *string `json:"title,omitempty"`
}
ItemSubstitutionOption Alternative product that can be substituted for an original order item when it becomes unavailable during fulfillment.
type ItemSubstitutionPreference ¶
type ItemSubstitutionPreference struct {
// SubstitutionOptions List of alternative products that can be substituted for the original item if it becomes unavailable.
SubstitutionOptions *[]ItemSubstitutionOption `json:"substitutionOptions,omitempty"`
// SubstitutionType Source and nature of the substitution preferences for this item.
SubstitutionType ItemSubstitutionPreferenceSubstitutionType `json:"substitutionType"`
}
ItemSubstitutionPreference Substitution preference for an order item when it becomes unavailable during fulfillment.
type ItemSubstitutionPreferenceSubstitutionType ¶
type ItemSubstitutionPreferenceSubstitutionType string
ItemSubstitutionPreferenceSubstitutionType Source and nature of the substitution preferences for this item.
const ( AMAZONRECOMMENDED ItemSubstitutionPreferenceSubstitutionType = "AMAZON_RECOMMENDED" CUSTOMERPREFERENCE ItemSubstitutionPreferenceSubstitutionType = "CUSTOMER_PREFERENCE" DONOTSUBSTITUTE ItemSubstitutionPreferenceSubstitutionType = "DO_NOT_SUBSTITUTE" )
Defines values for ItemSubstitutionPreferenceSubstitutionType.
type Measurement ¶
type Measurement struct {
// Unit The specific unit of measurement used to quantify this item.
Unit MeasurementUnit `json:"unit"`
// Value The numerical quantity or amount being measured in the specified unit.
Value float32 `json:"value"`
}
Measurement Specifies the unit of measure and quantity for items that are sold by weight, volume, length, or other measurements rather than simple count.
type MeasurementUnit ¶
type MeasurementUnit string
MeasurementUnit The specific unit of measurement used to quantify this item.
const ( CENTIMETERS MeasurementUnit = "CENTIMETERS" COUNT MeasurementUnit = "COUNT" CUBICCENTIMETERS MeasurementUnit = "CUBIC_CENTIMETERS" CUBICFEET MeasurementUnit = "CUBIC_FEET" CUBICINCHES MeasurementUnit = "CUBIC_INCHES" CUBICMETERS MeasurementUnit = "CUBIC_METERS" FEET MeasurementUnit = "FEET" FLUIDOUNCES MeasurementUnit = "FLUID_OUNCES" GALLONS MeasurementUnit = "GALLONS" GRAMS MeasurementUnit = "GRAMS" INCHES MeasurementUnit = "INCHES" KILOGRAMS MeasurementUnit = "KILOGRAMS" LITERS MeasurementUnit = "LITERS" METERS MeasurementUnit = "METERS" MILLIGRAMS MeasurementUnit = "MILLIGRAMS" MILLIMETERS MeasurementUnit = "MILLIMETERS" OUNCES MeasurementUnit = "OUNCES" PINTS MeasurementUnit = "PINTS" POUNDS MeasurementUnit = "POUNDS" QUARTS MeasurementUnit = "QUARTS" SQUARECENTIMETERS MeasurementUnit = "SQUARE_CENTIMETERS" SQUAREFEET MeasurementUnit = "SQUARE_FEET" SQUAREINCHES MeasurementUnit = "SQUARE_INCHES" SQUAREMETERS MeasurementUnit = "SQUARE_METERS" )
Defines values for MeasurementUnit.
type MerchantAddress ¶
type MerchantAddress struct {
// AddressLine1 The primary street address of the merchant's location.
AddressLine1 *string `json:"addressLine1,omitempty"`
// AddressLine2 Additional address information.
AddressLine2 *string `json:"addressLine2,omitempty"`
// AddressLine3 Additional address information.
AddressLine3 *string `json:"addressLine3,omitempty"`
// City The city of the address.
City *string `json:"city,omitempty"`
// CountryCode The two-letter country code for the address, in ISO 3166-1 format.
CountryCode *string `json:"countryCode,omitempty"`
// DistrictOrCounty The district or county of the address.
DistrictOrCounty *string `json:"districtOrCounty,omitempty"`
// Municipality The municipality of the address.
Municipality *string `json:"municipality,omitempty"`
// Name The name of the business or facility at this address.
Name *string `json:"name,omitempty"`
// PostalCode The postal code or ZIP code of the address.
PostalCode *string `json:"postalCode,omitempty"`
// StateOrRegion The state, province, or region of the address.
StateOrRegion *string `json:"stateOrRegion,omitempty"`
}
MerchantAddress The physical address of the merchant.
type Money ¶
type Money struct {
// Amount A decimal number with no loss of precision. Follows RFC 7159 for number representation.
Amount Decimal `json:"amount"`
// CurrencyCode The three-letter currency code that identifies the currency type, following ISO 4217 international standards.
CurrencyCode string `json:"currencyCode"`
}
Money An amount of money, including units in the form of currency.
type Order ¶
type Order struct {
// AssociatedOrders Other orders that have a direct relationship to this order, such as replacement or exchange orders.
AssociatedOrders *[]AssociatedOrder `json:"associatedOrders,omitempty"`
// Buyer Information about the customer who purchased the order.
Buyer *Buyer `json:"buyer,omitempty"`
// CreatedTime The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
CreatedTime time.Time `json:"createdTime"`
// Fulfillment Information about how the order is being processed, packed, and shipped to the customer.
Fulfillment *OrderFulfillment `json:"fulfillment,omitempty"`
// LastUpdatedTime The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
LastUpdatedTime time.Time `json:"lastUpdatedTime"`
// OrderAliases Alternative identifiers that can be used to reference this order, such as seller-defined order numbers.
OrderAliases *[]Alias `json:"orderAliases,omitempty"`
// OrderId An Amazon-defined order identifier.
OrderId string `json:"orderId"`
// OrderItems The list of all order items included in this order.
OrderItems []OrderItem `json:"orderItems"`
// Packages Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders.
Packages *[]OrderPackage `json:"packages,omitempty"`
// Proceeds The money that the seller receives from the sale of the order.
Proceeds *OrderProceeds `json:"proceeds,omitempty"`
// Programs Special programs associated with this order that may affect fulfillment or customer experience.
//
// **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`, `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`
Programs *[]string `json:"programs,omitempty"`
// Recipient Information about the recipient to whom the order should be delivered.
Recipient *Recipient `json:"recipient,omitempty"`
// SalesChannel Information about where the customer placed this order.
SalesChannel SalesChannel `json:"salesChannel"`
}
Order Comprehensive information about a customer order.
type OrderFulfillment ¶
type OrderFulfillment struct {
// DeliverByWindow A time period with start and end boundaries.
DeliverByWindow *DateTimeRange `json:"deliverByWindow,omitempty"`
// FulfilledBy Specifies whether Amazon or the merchant is responsible for fulfilling this order.
//
// **Possible values**: `AMAZON`, `MERCHANT`.
FulfilledBy *string `json:"fulfilledBy,omitempty"`
// FulfillmentServiceLevel The category of the shipping speed option selected by the customer at checkout.
//
// **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`.
FulfillmentServiceLevel *string `json:"fulfillmentServiceLevel,omitempty"`
// FulfillmentStatus The current fulfillment status of an order, indicating where the order is in the fulfillment process from placement to handover to carrier.
FulfillmentStatus FulfillmentStatus `json:"fulfillmentStatus"`
// ShipByWindow A time period with start and end boundaries.
ShipByWindow *DateTimeRange `json:"shipByWindow,omitempty"`
}
OrderFulfillment Information about how the order is being processed, packed, and shipped to the customer.
type OrderItem ¶
type OrderItem struct {
// Cancellation The cancellation information of the order item.
Cancellation *ItemCancellation `json:"cancellation,omitempty"`
// Expense The expense information related to this specific item.
Expense *ItemExpense `json:"expense,omitempty"`
// Fulfillment Information about how the order item should be processed, packed, and shipped to the customer.
Fulfillment *ItemFulfillment `json:"fulfillment,omitempty"`
// Measurement Specifies the unit of measure and quantity for items that are sold by weight, volume, length, or other measurements rather than simple count.
Measurement *Measurement `json:"measurement,omitempty"`
// OrderItemId A unique identifier for this specific item within the order.
OrderItemId string `json:"orderItemId"`
// Proceeds The money that the seller receives from the sale of this specific item.
Proceeds *ItemProceeds `json:"proceeds,omitempty"`
// Product Product information for an order item.
Product ItemProduct `json:"product"`
// Programs Special programs that apply specifically to this item within the order.
//
// **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`
Programs *[]string `json:"programs,omitempty"`
// Promotion Details about any discounts, coupons, or promotional offers applied to this item.
Promotion *ItemPromotion `json:"promotion,omitempty"`
// QuantityOrdered The number of units of this item that the customer ordered.
QuantityOrdered int `json:"quantityOrdered"`
}
OrderItem Information about a single product within an order.
type OrderPackage ¶
type OrderPackage struct {
// Carrier The carrier responsible for transporting this package to the customer.
Carrier *string `json:"carrier,omitempty"`
// CreatedTime The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
CreatedTime *time.Time `json:"createdTime,omitempty"`
// PackageItems A list of all order items included in this specific package.
PackageItems *[]PackageItem `json:"packageItems,omitempty"`
// PackageReferenceId A unique identifier for this package within the context of the order.
PackageReferenceId string `json:"packageReferenceId"`
// PackageStatus Current status and detailed tracking information for a shipping package throughout the delivery process.
PackageStatus *PackageStatus `json:"packageStatus,omitempty"`
// ShipFromAddress The physical address of the merchant.
ShipFromAddress *MerchantAddress `json:"shipFromAddress,omitempty"`
// ShipTime The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
ShipTime *time.Time `json:"shipTime,omitempty"`
// ShippingService The specific shipping method or service used for delivering this package.
ShippingService *string `json:"shippingService,omitempty"`
// TrackingNumber The carrier-provided tracking number that customers can use to monitor the package's delivery progress.
TrackingNumber *string `json:"trackingNumber,omitempty"`
}
OrderPackage Information about a physical shipping package, including tracking details. **Note:** Only available for merchant-fulfilled (FBM) orders.
type OrderProceeds ¶
type OrderProceeds struct {
// GrandTotal An amount of money, including units in the form of currency.
GrandTotal *Money `json:"grandTotal,omitempty"`
}
OrderProceeds The money that the seller receives from the sale of the order.
type PackageItem ¶
type PackageItem struct {
// OrderItemId Unique identifier of the order item included in this package.
OrderItemId string `json:"orderItemId"`
// Quantity Number of units of this item included in the package shipment.
Quantity int `json:"quantity"`
// TransparencyCodes The transparency codes associated with this item for product authentication.
TransparencyCodes *[]string `json:"transparencyCodes,omitempty"`
}
PackageItem Individual order item contained within a shipping package.
type PackageStatus ¶
type PackageStatus struct {
// DetailedStatus Granular status information providing specific details about the package's current location and handling stage.
//
// **Possible values:**
// - `PENDING_SCHEDULE` (Package awaiting pickup scheduling)
// - `PENDING_PICK_UP` (Package ready for carrier collection from seller)
// - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier)
// - `LABEL_CANCELLED` (Shipping label canceled by seller)
// - `PICKED_UP` (Package collected by carrier from seller location)
// - `DROPPED_OFF` (Package delivered to carrier by seller)
// - `AT_ORIGIN_FC` (Package at originating fulfillment center)
// - `AT_DESTINATION_FC` (Package at destination fulfillment center)
// - `DELIVERED` (Package successfully delivered to recipient)
// - `REJECTED_BY_BUYER` (Package refused by intended recipient)
// - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues)
// - `RETURNING_TO_SELLER` (Package in transit back to seller)
// - `RETURNED_TO_SELLER` (Package successfully returned to seller)
// - `LOST` (Package location unknown or confirmed lost)
// - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery)
// - `DAMAGED` (Package damaged during transit)
DetailedStatus *string `json:"detailedStatus,omitempty"`
// Status Primary status classification of the package in the shipping workflow.
Status PackageStatusStatus `json:"status"`
}
PackageStatus Current status and detailed tracking information for a shipping package throughout the delivery process.
type PackageStatusStatus ¶
type PackageStatusStatus string
PackageStatusStatus Primary status classification of the package in the shipping workflow.
const ( PackageStatusStatusCANCELLED PackageStatusStatus = "CANCELLED" PackageStatusStatusDELIVERED PackageStatusStatus = "DELIVERED" PackageStatusStatusINTRANSIT PackageStatusStatus = "IN_TRANSIT" PackageStatusStatusPENDING PackageStatusStatus = "PENDING" PackageStatusStatusSHIPPED PackageStatusStatus = "SHIPPED" PackageStatusStatusUNDELIVERABLE PackageStatusStatus = "UNDELIVERABLE" )
Defines values for PackageStatusStatus.
type Pagination ¶
type Pagination struct {
// NextToken A token that can be used to fetch the next page of results.
NextToken *string `json:"nextToken,omitempty"`
}
Pagination When a request has results that are not included in the response, pagination occurs. This means the results are divided into individual pages. To retrieve a different page, you must pass the token value as the `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from the response.
type PointsGranted ¶
type PointsGranted struct {
// PointsMonetaryValue An amount of money, including units in the form of currency.
PointsMonetaryValue *Money `json:"pointsMonetaryValue,omitempty"`
// PointsNumber Total number of Amazon Points granted to the customer's account for this item purchase.
PointsNumber *int `json:"pointsNumber,omitempty"`
}
PointsGranted Information about Amazon Points awarded with an item purchase.
type PreferredDeliveryCapability ¶
type PreferredDeliveryCapability = string
PreferredDeliveryCapability Special delivery capabilities available at the shipping address that may affect delivery options and methods.
**Possible values:** - `HAS_ACCESS_POINT` (Delivery location includes designated pickup or drop-off access points) - `PALLET_ENABLED` (Address is equipped to receive large pallet deliveries) - `PALLET_DISABLED` (Address cannot accommodate pallet delivery methods)
type PreferredDeliveryTime ¶
type PreferredDeliveryTime struct {
// BusinessHours Business hours when the business is open for deliveries.
BusinessHours *[]BusinessHour `json:"businessHours,omitempty"`
// ExceptionDates Specific dates within the next 30 days when normal business hours do not apply.
ExceptionDates *[]ExceptionDate `json:"exceptionDates,omitempty"`
}
PreferredDeliveryTime Customer-specified time preferences for when deliveries should be attempted at the destination address.
type Recipient ¶
type Recipient struct {
// DeliveryAddress The physical address of the customer.
DeliveryAddress *CustomerAddress `json:"deliveryAddress,omitempty"`
// DeliveryPreference Contains all delivery instructions that the customer provides for the shipping address.
DeliveryPreference *DeliveryPreference `json:"deliveryPreference,omitempty"`
}
Recipient Information about the recipient to whom the order should be delivered.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ResponseEditorFn ¶
ResponseEditorFn is the function signature for the ResponseEditor callback function
type SKU ¶
type SKU = string
SKU The seller SKU of a product (catalog item). This is a unique number assigned by the seller when listing an item.
type SalesChannel ¶
type SalesChannel struct {
// ChannelName The name of the sales platform or channel where the customer placed this order.
//
// **Possible values**: `AMAZON`, `NON_AMAZON`
ChannelName string `json:"channelName"`
// MarketplaceId The unique identifier for the specific marketplace within the sales channel where this order was placed.
MarketplaceId *string `json:"marketplaceId,omitempty"`
// MarketplaceName The human-readable name of the marketplace where this order was placed.
MarketplaceName *string `json:"marketplaceName,omitempty"`
}
SalesChannel Information about where the customer placed this order.
type SearchOrdersParams ¶
type SearchOrdersParams struct {
// CreatedAfter The response includes orders created at or after this time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
//
// **Note**: You must provide exactly one of `createdAfter` and `lastUpdatedAfter` in your request. If `createdAfter` is provided, neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.
CreatedAfter *time.Time `form:"createdAfter,omitempty" json:"createdAfter,omitempty"`
// CreatedBefore The response includes orders created at or before this time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
//
// **Note**: If you include `createdAfter` in the request, `createdBefore` is optional, and if provided must be equal to or after the `createdAfter` date and at least two minutes before the time of the request. If `createdBefore` is provided, neither `lastUpdatedAfter` nor `lastUpdatedBefore` may be provided.
CreatedBefore *time.Time `form:"createdBefore,omitempty" json:"createdBefore,omitempty"`
// LastUpdatedAfter The response includes orders updated at or after this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
//
// **Note**: You must provide exactly one of `createdAfter` and `lastUpdatedAfter`. If `lastUpdatedAfter` is provided, neither `createdAfter` nor `createdBefore` may be provided.
LastUpdatedAfter *time.Time `form:"lastUpdatedAfter,omitempty" json:"lastUpdatedAfter,omitempty"`
// LastUpdatedBefore The response includes orders updated at or before this time. An update is defined as any change made by Amazon or by the seller, including an update to the order status. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
//
// **Note**: If you include `lastUpdatedAfter` in the request, `lastUpdatedBefore` is optional, and if provided must be equal to or after the `lastUpdatedAfter` date and at least two minutes before the time of the request. If `lastUpdatedBefore` is provided, neither `createdAfter` nor `createdBefore` may be provided.
LastUpdatedBefore *time.Time `form:"lastUpdatedBefore,omitempty" json:"lastUpdatedBefore,omitempty"`
// FulfillmentStatuses A list of `FulfillmentStatus` values you can use to filter the results.
FulfillmentStatuses *[]SearchOrdersParamsFulfillmentStatuses `form:"fulfillmentStatuses,omitempty" json:"fulfillmentStatuses,omitempty"`
// MarketplaceIds The response includes orders that were placed in marketplaces you include in this list.
//
// Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
MarketplaceIds *[]string `form:"marketplaceIds,omitempty" json:"marketplaceIds,omitempty"`
// FulfilledBy The response includes orders that are fulfilled by the parties that you include in this list.
FulfilledBy *[]SearchOrdersParamsFulfilledBy `form:"fulfilledBy,omitempty" json:"fulfilledBy,omitempty"`
// MaxResultsPerPage The maximum number of orders that can be returned per page. The value must be between 1 and 100. **Default:** 100.
MaxResultsPerPage *int `form:"maxResultsPerPage,omitempty" json:"maxResultsPerPage,omitempty"`
// PaginationToken Pagination occurs when a request produces a response that exceeds the `maxResultsPerPage`. This means that the response is divided into individual pages. To retrieve the next page, you must pass the `nextToken` value as the `paginationToken` query parameter in the next request. You will not receive a `nextToken` value on the last page.
PaginationToken *string `form:"paginationToken,omitempty" json:"paginationToken,omitempty"`
// IncludedData A list of datasets to include in the response.
IncludedData *[]SearchOrdersParamsIncludedData `form:"includedData,omitempty" json:"includedData,omitempty"`
}
SearchOrdersParams defines parameters for SearchOrders.
type SearchOrdersParamsFulfilledBy ¶
type SearchOrdersParamsFulfilledBy string
SearchOrdersParamsFulfilledBy defines parameters for SearchOrders.
const ( AMAZON SearchOrdersParamsFulfilledBy = "AMAZON" MERCHANT SearchOrdersParamsFulfilledBy = "MERCHANT" )
Defines values for SearchOrdersParamsFulfilledBy.
type SearchOrdersParamsFulfillmentStatuses ¶
type SearchOrdersParamsFulfillmentStatuses string
SearchOrdersParamsFulfillmentStatuses defines parameters for SearchOrders.
const ( CANCELLED SearchOrdersParamsFulfillmentStatuses = "CANCELLED" PARTIALLYSHIPPED SearchOrdersParamsFulfillmentStatuses = "PARTIALLY_SHIPPED" PENDING SearchOrdersParamsFulfillmentStatuses = "PENDING" PENDINGAVAILABILITY SearchOrdersParamsFulfillmentStatuses = "PENDING_AVAILABILITY" SHIPPED SearchOrdersParamsFulfillmentStatuses = "SHIPPED" UNFULFILLABLE SearchOrdersParamsFulfillmentStatuses = "UNFULFILLABLE" UNSHIPPED SearchOrdersParamsFulfillmentStatuses = "UNSHIPPED" )
Defines values for SearchOrdersParamsFulfillmentStatuses.
type SearchOrdersParamsIncludedData ¶
type SearchOrdersParamsIncludedData string
SearchOrdersParamsIncludedData defines parameters for SearchOrders.
const ( SearchOrdersParamsIncludedDataBUYER SearchOrdersParamsIncludedData = "BUYER" SearchOrdersParamsIncludedDataCANCELLATION SearchOrdersParamsIncludedData = "CANCELLATION" SearchOrdersParamsIncludedDataEXPENSE SearchOrdersParamsIncludedData = "EXPENSE" SearchOrdersParamsIncludedDataFULFILLMENT SearchOrdersParamsIncludedData = "FULFILLMENT" SearchOrdersParamsIncludedDataPACKAGES SearchOrdersParamsIncludedData = "PACKAGES" SearchOrdersParamsIncludedDataPROCEEDS SearchOrdersParamsIncludedData = "PROCEEDS" SearchOrdersParamsIncludedDataPROMOTION SearchOrdersParamsIncludedData = "PROMOTION" SearchOrdersParamsIncludedDataRECIPIENT SearchOrdersParamsIncludedData = "RECIPIENT" )
Defines values for SearchOrdersParamsIncludedData.
type SearchOrdersResp ¶
type SearchOrdersResp struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SearchOrdersResponse
JSON400 *ErrorList
JSON403 *ErrorList
JSON404 *ErrorList
JSON413 *ErrorList
JSON415 *ErrorList
JSON429 *ErrorList
JSON500 *ErrorList
JSON503 *ErrorList
}
func ParseSearchOrdersResp ¶
func ParseSearchOrdersResp(rsp *http.Response) (*SearchOrdersResp, error)
ParseSearchOrdersResp parses an HTTP response from a SearchOrdersWithResponse call
func (SearchOrdersResp) Status ¶
func (r SearchOrdersResp) Status() string
Status returns HTTPResponse.Status
func (SearchOrdersResp) StatusCode ¶
func (r SearchOrdersResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SearchOrdersResponse ¶
type SearchOrdersResponse struct {
// CreatedBefore Only orders placed before the specified time are returned. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
CreatedBefore *time.Time `json:"createdBefore,omitempty"`
// LastUpdatedBefore Only orders updated before the specified time are returned. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
LastUpdatedBefore *time.Time `json:"lastUpdatedBefore,omitempty"`
// Orders An array containing all orders that match the search criteria.
Orders []Order `json:"orders"`
// Pagination When a request has results that are not included in the response, pagination occurs. This means the results are divided into individual pages. To retrieve a different page, you must pass the token value as the `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from the response.
Pagination *Pagination `json:"pagination,omitempty"`
}
SearchOrdersResponse A list of orders.
type TimeWindow ¶
type TimeWindow struct {
// EndTime The time when the business opens or closes.
EndTime *HourMinute `json:"endTime,omitempty"`
// StartTime The time when the business opens or closes.
StartTime *HourMinute `json:"startTime,omitempty"`
}
TimeWindow Specific time interval defining the start and end times.