Overview
Configuration is provided for establishing connections with Amazon Selling Partner service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you step-by-step how to create a connection to Amazon Selling Partner REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Amazon Selling Partner.
Step 3. In the server host parameter select the REGION to desired region. It can be one of the following na, eu and fe. Set the Authentication type to Self Authorization using drop down list for parameter Authentication
Step 4. Provide credentials for the parameters in the grid in below and hit Test connection. to test your connection.
Congratulations! You have now established a connection to your Amazon Selling Partner instance.
In this guide, we will show you step-by-step how to create a connection to Amazon Selling Partner REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Amazon Selling Partner.
Step 3. In the server host parameter select the REGION to desired region. It can be one of the following na, eu and fe. Set the Authentication type to OAUTH using drop down list for parameter Authentciation
Step 4. Then click New in the Token File parameter to create a new token file.
Step 5. In the next wizard specify credentials for the available parameteres and hit Next.
Step 6. Proceed with the Login steps and Authorization. Save generated access token to file. Specify token protection password. Click OK.
Step 7. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Amazon Selling Partner instance.
In this guide, we will show how to read data from the Amazon Selling Partner service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Amazon Selling Partner connection from the combo. Select from available Amazon Selling Partner resources listed in the second combo below.
You can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Amazon Selling Partner resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Amazon Selling Partner service.
In this guide, we will show how to write data to the Amazon Selling Partner service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Amazon Selling Partner connection from the combo. Also, select resource action and Amazon Selling Partner resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Amazon Selling Partner resource.
Configuration
Base URL address: https://sellingpartnerapi-[REGION].amazon.com.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- application_id: Required. Specify application client secret.
- client_id: Required. Specify the application client id.
- client_secret: Required. Specify the application client secret.
- redirectUri: Required. Specify SP app id.
- Access Key: Required. Specify access key.
- Secret Key: Required. Specify secret key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=aws4s.makeAuthorization(request, connection, token.Access)}} -
Host:
{{=request.signedRequest.headers['Host']}} -
X-Amz-Content-Sha256:
{{=request.signedRequest.headers['X-Amz-Content-Sha256']}} -
X-Amz-Date:
{{=request.signedRequest.headers['X-Amz-Date']}} -
x-amz-access-token:
{{=token.Access}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/authorizing-selling-partner-api-applications.
- Self Authorization
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Sepcify the application client id.
- client_secret: Required. Specify application client secret.
- refresh_token: Required. Specify application refresh token.
- Access Key: Required. Specify access key.
- Secret Key: Required. Specify secret key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=aws4s.makeAuthorization(request, connection, token.Access)}} -
Host:
{{=request.signedRequest.headers['Host']}} -
X-Amz-Content-Sha256:
{{=request.signedRequest.headers['X-Amz-Content-Sha256']}} -
X-Amz-Date:
{{=request.signedRequest.headers['X-Amz-Date']}} -
x-amz-access-token:
{{=token.Access}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/authorizing-selling-partner-api-applications.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/v0/orders.
The result is extracted from:{{=response.payload.Orders}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify list of MarketplaceId values.
- LastUpdatedAfter: Specify a date used for selecting orders created after (or at) a specified time .
- CreatedAfter: Specify a date used for selecting orders that were last updated after (or at) a specified time .
The following request parameters will be automatically processed:
-
MarketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/orders-api-v0-reference#getorders.
- [Read single] action
-
Endpoint URL address:
/orders/v0/orders/{{=parameters.order_id}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- order_id: Required. Specify the order identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/orders-api-v0-reference#get-ordersv0ordersorderid.
- AmazonOrderId
A key field. Template: ShortText.
- BuyerInfo
Template: BuyerInfoT.
- EarliestDeliveryDate
Template: DateTime.
- EarliestShipDate
Template: DateTime.
- SalesChannel
Template: ShortText.
- AutomatedShippingSettings
Field components:
- Contains the following components: HasAutomatedShippingSettings.
- OrderStatus
Template: ShortText.
- NumberOfItemsShipped
Data type: DT_I4
- OrderType
Template: ShortText.
- IsPremiumOrder
Data type: DT_BOOL
- IsPrime
Data type: DT_BOOL
- FulfillmentChannel
Template: ShortText.
- NumberOfItemsUnshipped
Data type: DT_I4
- HasRegulatedItems
Data type: DT_BOOL
- IsReplacementOrder
Data type: DT_BOOL
- IsSoldByAB
Data type: DT_BOOL
- LatestShipDate
Template: DateTime.
- ShipServiceLevel
Template: ShortText.
- DefaultShipFromLocationAddress
Template: AddressT.
- IsISPU
Data type: DT_BOOL
- MarketplaceId
Template: ShortText.
- LatestDeliveryDate
Template: DateTime.
- PurchaseDate
Template: DateTime.
- ShippingAddress
Template: AddressT.
- IsAccessPointOrder
Data type: DT_BOOL
- PaymentMethod
Template: ShortText.
- IsBusinessOrder
Data type: DT_BOOL
- OrderTotal
Template: Money.
- PaymentMethodDetails
Template: LongText. A composite field.
- IsGlobalExpressEnabled
Data type: DT_BOOL
- LastUpdateDate
Template: DateTime. A read-only field.
- ShipmentServiceLevelCategory
Template: ShortText.
- BuyerInfoDetail
Template: BuyerInfoT. The value is gathered from
/orders/v0/orders/{{=item.AmazonOrderId}}/buyerInfoaddress. The gathered value is processed with{{=response.payload}}expression.- OrderAddress
The value is gathered from
/orders/v0/orders/{{=item.AmazonOrderId}}/addressaddress. The gathered value is processed with{{=response.payload}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, ShippingAddress.
-
Uses template:
- OrderItems
The value is gathered from
/orders/v0/orders/{{=item.AmazonOrderId}}/orderItemsaddress. The gathered value is processed with{{=response.payload.OrderItems}}expression. Field components:- An array.
- Contains the following components: OrderItemId, TaxCollection, ProductInfo, BuyerInfo, ItemTax, QuantityShipped, BuyerRequestedCancel, ItemPrice, ASIN, SellerSKU, Title, IsGift, ConditionSubtypeId, IsTransparency, QuantityOrdered, PromotionDiscountTax, ConditionId, PromotionDiscount.
- OrderItemsBuyerInfo
The value is gathered from
/orders/v0/orders/{{=item.AmazonOrderId}}/orderItems/buyerInfoaddress. The gathered value is processed with{{=response.payload.OrderItems}}expression. Field components:- An array.
- Contains the following components: OrderItemId, GiftWrapPrice, GiftWrapTax, GiftMessageText, GiftWrapLevel, BuyerCustomizedInfo.
- RegulatedInfo
The value is gathered from
/orders/v0/orders/{{=item.AmazonOrderId}}/regulatedInfoaddress. The gathered value is processed with{{=response.payload[field.name]}}expression. Field components:- Contains the following components: RegulatedInformation, RequiresDosageLabel, RegulatedOrderVerificationStatus.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/orders/v0/orders/{{=parameters.AmazonOrderId}/shipment.
The action uses POST method.The action has the following user-defined parameters:
- AmazonOrderId: Required. Specify an Amazon-defined order identifier, in 3-7-7 format.
Documentation: https://developer-docs.amazon.com/sp-api/docs/orders-api-v0-reference#updateshipmentstatus.
- marketplaceId
Template: ShortText.
- shipmentStatus
Template: ShortText.
- orderItems
Field components:
- An array.
- Contains the following components: orderItemId, quantity.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/orders/v0/orders/{{=parameters.AmazonOrderId}/regulatedInfo.
The action uses PATCH method.The action has the following user-defined parameters:
- AmazonOrderId: Required. Specify an Amazon-defined order identifier, in 3-7-7 format.
The following request parameters will be automatically processed:
-
application/json:
{{={ regulatedOrderVerificationStatus : item } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/orders-api-v0-reference#updateshipmentstatus.
- externalReviewerId
Template: ShortText.
- status
Template: ShortText.
- rejectionReasonId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shipping/v1/shipments/{{=parameters.shipmentId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- shipmentId: Required. Specify the shipment identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/shipping-api-v1-reference#getshipment.
- [Create] action
-
Endpoint URL address:
/shipping/v1/shipments.Documentation: https://developer-docs.amazon.com/sp-api/docs/shipping-api-v1-reference#createshipmentrequest.
- [Delete] action
-
Endpoint URL address:
/shipping/v1/shipments/{{=item.shipmentId}}/cancel.
The action uses POST method.Documentation: https://developer-docs.amazon.com/sp-api/docs/shipping-api-v1-reference#cancelshipment.
- shipmentId
A key field. Template: ShortText.
- clientReferenceId
Template: ShortText.
- shipTo
Template: ShippingAddressT.
- shipFrom
Template: ShippingAddressT.
- acceptedRate
A read-only field. Field components:
-
Uses template:
UnitValueT. - Contains the following components: billedWeight, totalCharge, serviceType, promise.
-
Uses template:
- shipper
Field components:
-
Uses template:
ShortText. - Contains the following components: accountId.
-
Uses template:
- containers
Field components:
- An array.
-
Uses template:
ShippingContainerT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: purchaseShipment, purchaseLabel.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shipping/v1/rates.
The result is extracted from:{{=response.payload.serviceRates}}.
The action uses POST method.The action has the following user-defined parameters:
- JSON: Specify Rate Request in JSON format.
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.get('JSON') ? JSON.parse(parameters.JSON) : parameters}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/shipping-api-v1-reference#getrates.
- totalCharge
Template: UnitValueT.
- billableWeight
Template: UnitValueT.
- serviceType
Template: ShortText.
- promise
Template: ShippingPromiseT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shipping/v1/tracking/{{=parameters.trackingId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- trackingId: Required. Specify the tracking identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/shipping-api-v1-reference#gettrackinginformation.
- trackingId
Template: ShortText.
- summary
Template: ShortText.
- promisedDeliveryDate
Template: DateTime.
- eventHistory
Field components:
- An array.
- Contains the following components: eventCode, eventTime, location.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/fba/outbound/brazil/v0/shipments/{{=parameters.AmazonShipmentId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- AmazonShipmentId: Required. Specify the shipment identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/shipment-invoicing-api-v0-reference#getshipmentdetails.
- [Create] action
-
Endpoint URL address:
/fba/outbound/brazil/v0/shipments/{{=item.AmazonShipmentId}}/invoice.The following request parameters will be automatically processed:
-
application/json:
{{=function(item) { var content = item.InvoiceContent.readAll(); return { MarketplaceId: item.MarketplaceId, InvoiceContent: Convert.ToBase64String(content), ContentMD5Value: Convert.ToBase64String(MD5.Create().ComputeHash(content)) }; }(item)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/shipment-invoicing-api-v0-reference#submitinvoice.
-
application/json:
- AmazonShipmentId
A key field. Template: ShortText.
- WarehouseId
Template: ShortText.
- AmazonOrderId
Template: ShortText.
- PurchaseDate
Template: DateTime.
- ShippingAddress
Template: AddressT.
- PaymentMethodDetails
Template: LongText. A composite field.
- MarketplaceId
Template: ShortText.
- SellerId
Template: ShortText.
- BuyerName
Template: ShortText.
- BuyerCounty
Template: ShortText.
- BuyerTaxInfo
Template: BuyerTaxInfoT.
- MarketplaceTaxInfo
Template: BuyerTaxInfoT.
- SellerDisplayName
Template: ShortText.
- InvoiceContent
Data type: DT_IMAGE
- ContentMD5Value
Template: ShortText.
- ShipmentItems
Field components:
- An array.
- Contains the following components: ASIN, SellerSKU, OrderItemId, Title, QuantityOrdered, ItemPrice, ShippingPrice, GiftWrapPrice, ShippingDiscount, PromotionDiscount, SerialNumbers.
- InvoiceStatus
Template: ShortText. The value is gathered from
/fba/outbound/brazil/v0/shipments/{{=item.AmazonShipmentId}}/invoice/statusaddress. The gathered value is processed with{{=response.payload.Shipments.InvoiceStatus}}expression.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/solicitations/v1/orders/{{=parameters.amazonOrderId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- amazonOrderId: Required. Specify the amazon order identifier.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/solicitations-api-v1-reference.
- [Create] action
-
Endpoint URL address:
solicitations/v1/orders/{{=item.amazonOrderId}}/solicitations/productReviewAndSellerFeedback.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/solicitations-api-v1-reference.
- amazonOrderId
A key field. Template: ShortText.
- _links
Field components:
-
Uses template:
SolicitationLinkT. - Contains the following components: actions, self.
-
Uses template:
- _embedded
Field components:
- Contains the following components: actions.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales/v1/orderMetrics.
The result is extracted from:{{=response.payload}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- interval: Required. Specify a time interval used for selecting order metrics.
- granularity: Required. Specify granularity of the grouping of order metrics, based on a unit of time.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/sales-api-v1-reference.
- interval
Template: ShortText.
- unitCount
Data type: DT_I4
- orderItemCount
Data type: DT_I4
- orderCount
Data type: DT_I4
- averageUnitPrice
Template: CurrencyTwo.
- totalSales
Template: CurrencyTwo.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/sellers/v1/marketplaceParticipations.
The result is extracted from:{{=response.payload}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/sellers-api-v1-reference#getmarketplaceparticipations.
- marketplace
Field components:
-
Uses template:
ShortText. - Contains the following components: id, countryCode, name, defaultCurrencyCode, defaultLanguageCode, domainName.
-
Uses template:
- participation
Field components:
- Contains the following components: isParticipating, hasSuspendedListings.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/service/v1/reservation.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#createreservation.
- [Update] action
-
Endpoint URL address:
/service/v1/reservation/{{=item.reservationId}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#updatereservation.
- [Delete] action
-
Endpoint URL address:
/service/v1/reservation/{{=item.reservationId}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#cancelreservation.
- resourceId
A key field. Template: ShortText.
- reservationId
A key field. Template: ShortText.
- reservation
Field components:
-
Uses template:
ShortText. - Contains the following components: availability, type, reservationId.
-
Uses template:
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/service/v1/serviceResources/{{=item.resourceId}}/schedules.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the resource operate.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
application/json:
{{={ schedules : [item] } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#updateschedule.
- startTime
Template: DateTime.
- endTime
Template: DateTime.
- recurrence
Field components:
-
Uses template:
DateTime. - Contains the following components: endTime, daysOfWeek.
-
Uses template:
- capacity
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/service/v1/serviceResources/{{=parameters.resourceId}}/capacity/range.
The result is extracted from:{{=response.capacities}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- resourceId: Required. Specify the resource identifier.
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- capacityTypes: Required. Specify the capacity types in format ["SCHEDULED_CAPACITY", "AVAILABLE_CAPACITY"].
- startDateTime: Required. Specify Start date time from which the capacity slots are being requested in ISO 8601 format.
- endDateTime: Required. Specify End date time up to which the capacity slots are being requested in ISO 8601 format.
The following request parameters will be automatically processed:
-
application/json:
{{={ capacityTypes : JSON.parse(parameters.capacityTypes), startDateTime : JSON.parse(parameters.startDateTime), endDateTime: JSON.parse(parameters.endDateTime) } }} -
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
nextPageToken:
{{=parameters.iterator}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#getrangeslotcapacity.
- [Read fixed] action
-
Endpoint URL address:
/service/v1/serviceResources/{{=parameters.resourceId}}/capacity/fixed.
The result is extracted from:{{=response.capacities}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- resourceId: Required. Specify the resource identifier.
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- capacityTypes: Required. Specify the capacity types in format ["SCHEDULED_CAPACITY", "AVAILABLE_CAPACITY"].
- slotDuration: Required. Specify Size in which slots are being requested. This value should be a multiple of 5 and fall in the range: 5 less or equal to slotDuration less or equal to 360
- startDateTime: Required. Specify Start date time from which the capacity slots are being requested in ISO 8601 format.
- endDateTime: Required. Specify End date time up to which the capacity slots are being requested in ISO 8601 format.
The following request parameters will be automatically processed:
-
application/json:
{{={ capacityTypes : JSON.parse(parameters.capacityTypes), slotDuration : JSON.parse(parameters.slotDuration), startDateTime : JSON.parse(parameters.startDateTime), endDateTime: JSON.parse(parameters.endDateTime) } }} -
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
nextPageToken:
{{=parameters.iterator}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#getfixedslotcapacity.
- capacityType
Template: ShortText.
- startDateTime
Template: DateTime. A read-only field.
- scheduledCapacity
Data type: DT_I4
- reservedCapacity
Data type: DT_I4
- availableCapacity
Data type: DT_I4
- encumberedCapacity
Data type: DT_I4
- slots
Field components:
- An array.
- Contains the following components: startDateTime, endDateTime, capacity.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/service/v1/serviceJobs.
The result is extracted from:{{=response.payload.jobs}}.
The result is paginated.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- createdAfter: Specify if LastUpdatedAfter is not specified. A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format.
- lastUpdatedAfter: Specify if createdAfter is not specified. A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
pageToken:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#getservicejobs.
- [Read single] action
-
Endpoint URL address:
/service/v1/serviceJobs/{{=parameters.serviceJobId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- serviceJobId: Required. Specify the service job identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/services-api-v1-reference#getservicejobbyservicejobid.
- serviceJobId
A key field. Template: ShortText.
- serviceOrderId
Template: ShortText.
- createTime
Template: DateTime.
- serviceJobStatus
Template: ShortText.
- scopeOfWork
Field components:
-
Uses template:
ShortText. - Contains the following components: asin, title, quantity, requiredSkills.
-
Uses template:
- seller
Field components:
-
Uses template:
ShortText. - Contains the following components: sellerId.
-
Uses template:
- serviceJobProvider
Field components:
-
Uses template:
ShortText. - Contains the following components: serviceJobProviderId.
-
Uses template:
- preferredAppointmentTimes
Field components:
- An array.
- Contains the following components: startTime, durationInMinutes.
- buyer
Field components:
-
Uses template:
ShortText. - Contains the following components: name.
-
Uses template:
- appointments
Field components:
- An array.
- Contains the following components: appointmentId, appointmentStatus, appointmentTime, assignedTechnicians.
- marketplaceId
Template: ShortText.
- storeId
Template: ShortText.
- associatedItems
Field components:
- An array.
- Contains the following components: asin, title, quantity, orderId, itemStatus, brandName, itemDelivery.
- serviceLocation
Field components:
-
Uses template:
ShortText. - Contains the following components: serviceLocationType, address.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ShortText. - Contains the following components: cancel, complete, addAppointment, rescheduleAppointment.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/finances/v0/financialEvents.
The result is extracted from:{{=ASP.getFinanceResult(response.payload.FinancialEvents[parameters.eventType])}}.The action has the following user-defined parameters:
- eventType: Required. Specify eventType.
- PostedAfter: Specify a date used for selecting financial events posted after (or at) a specified time.
- PostedBefore: Specify a date used for selecting financial events posted before (but not at) a specified time.
Documentation: https://developer-docs.amazon.com/sp-api/docs/finances-api-reference#listfinancialevents.
- [Read group] action
-
Endpoint URL address:
/finances/v0/financialEventGroups/{{=parameters.eventGroupId}}/financialEvents.
The result is extracted from:{{=ASP.getFinanceResult(response.payload.FinancialEvents[parameters.eventType])}}.The action has the following user-defined parameters:
- eventType: Required. Specify eventType.
- eventGroupId: Required. Specify the identifier of the financial event group to which the events belong.
- PostedAfter: Specify a date used for selecting financial events posted after (or at) a specified time.
- PostedBefore: Specify a date used for selecting financial events posted before (but not at) a specified time.
Documentation: https://developer-docs.amazon.com/sp-api/docs/finances-api-reference#listfinancialeventsbygroupid.
- [Read order] action
-
Endpoint URL address:
/finances/v0/financialEventGroups/{{=parameters.AmazonOrderId}}/financialEvents.
The result is extracted from:{{=ASP.getFinanceResult(response.payload.FinancialEvents[parameters.eventType])}}.The action has the following user-defined parameters:
- eventType: Required. Specify eventType.
- AmazonOrderId: Required. Specify an Amazon-defined order identifier.
- PostedAfter: Specify a date used for selecting financial events posted after (or at) a specified time.
- PostedBefore: Specify a date used for selecting financial events posted before (but not at) a specified time.
Documentation: https://developer-docs.amazon.com/sp-api/docs/finances-api-reference#listfinancialeventsbyorderid.
- [External]
-
The external fields list is extracted from:
{{=[{ template: parameters.eventType }]}}.- Event
Template: {{=ASP.getFieldTemplate(external.template)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/finances/v0/financialEventGroups.
The result is extracted from:{{=response.payload.FinancialEventGroupList}}.The action has the following user-defined parameters:
- FinancialEventGroupStartedBefore: Specify a date used for selecting financial event groups that opened before (but not at) a specified date and time.
- FinancialEventGroupStartedAfter: Specify a date used for selecting financial event groups that opened after (or at) a specified date and time.
Documentation: https://developer-docs.amazon.com/sp-api/docs/finances-api-reference#listfinancialeventgroups.
- FinancialEventGroupId
A key field. Template: ShortText.
- ProcessingStatus
Template: ShortText.
- OriginalTotal
Template: Currency.
- BeginningBalance
Template: Currency.
- FinancialEventGroupStart
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/listings/{{=parameters.apiVersion}}/items/{{=parameters.sellerId}}/{{=parameters.sku}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- apiVersion: Required. Specify the version of listing items api.
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- sellerId: Required. Specify a selling partner identifier, such as a merchant account or vendor code.
- sku: Required. Specify a comma-delimited list of Amazon marketplace identifiers for the request..
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#getlistingsitem.
- [Create] action
-
Endpoint URL address:
/listings/{{=parameters.apiVersion}}/items/{{=parameters.sellerId}}/{{=item.sku}}.
The action uses PUT method.The action has the following user-defined parameters:
- apiVersion: Required. Specify the version of listing items api.
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- sellerId: Required. Specify a selling partner identifier, such as a merchant account or vendor code.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
issueLocale:
{{=parameters.get('issueLocale')}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#putlistingsitem.
- [Update] action
-
Endpoint URL address:
/listings/{{=parameters.apiVersion}}/items/{{=parameters.sellerId}}/{{=item.sku}}.
The action uses PATCH method.The action has the following user-defined parameters:
- apiVersion: Required. Specify the version of listing items api.
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- sellerId: Required. Specify a selling partner identifier, such as a merchant account or vendor code.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
issueLocale:
{{=parameters.get('issueLocale')}} -
application/json:
{{={ productType: item.productType, patches: _.map( _.omit(item, 'productType'), function(v, k) { return { op: 'replace', path: '/attributes/' + k, value: v }; } ) } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#patchoperation.
- [Delete] action
-
Endpoint URL address:
/listings/{{=parameters.apiVersion}}/items/{{=parameters.sellerId}}/{{=item.sku}}.The action has the following user-defined parameters:
- apiVersion: Required. Specify the version of listing items api.
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
- sellerId: Required. Specify a selling partner identifier, such as a merchant account or vendor code.
The following request parameters will be automatically processed:
-
issueLocale:
{{=parameters.get('issueLocale')}} -
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#putlistingsitem.
- sku
A key field. Template: ShortText.
- productType
Template: ShortText.
- requirements
Template: ShortText.
- ItemAttributes
Template: LongText. A composite field.
- summaries
Field components:
- An array.
- Contains the following components: marketplaceId, asin, productType, conditionType, status, itemName, createdDate, lastUpdatedDate, mainImage.
- offers
Field components:
- An array.
- Contains the following components: marketplaceId, offerType, price.
- ItemProcurement
Field components:
- An array.
- fulfillmentAvailability
Field components:
- An array.
- Contains the following components: fulfillmentChannelCode, quantity.
- issues
Field components:
- An array.
- Contains the following components: code, message, severity, attributeNames.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/listings/2021-08-01/restrictions.
The result is extracted from:{{=response.restrictions}}.The action has the following user-defined parameters:
- apiVersion: Required. Specify the version of listing items api.
- MarketplaceIds: Required. Specify only the Marketplaces identifiers for the request.
- asin: Required. Specify Amazon Standard Identification Number (ASIN) of the item.
- sellerId: Required. Specify a selling partner identifier, such as a merchant account or vendor code.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-reference#restrictionlist.
- marketplaceId
Template: ShortText.
- conditionType
Template: ShortText.
- reasons
Field components:
- An array.
- Contains the following components: message, reasonCode, links.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/mfn/v0/shipments/{{=parameters.shipmentId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- shipmentId: Required. Specify Amazon-defined shipment identifier for the shipment.
Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#getshipment.
- [Create] action
-
Endpoint URL address:
/mfn/v0/shipments.The following request parameters will be automatically processed:
-
application/json:
{{={_.extend( { ShipmentRequestDetails : _.omit(item, 'ShippingServiceId', 'ShippingServiceOfferId', 'HazmatType', 'LabelFormatOption', 'ShipmentLevelSellerInputsList') }, item )}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#createshipment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/mfn/v0/shipments/{{=item.shipmentId}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#cancelshipment.
- ShipmentId
A key field. Template: ShortText.
- AmazonOrderId
Template: ShortText.
- SellerOrderId
Template: ShortText.
- Insurance
Template: Money.
- ItemList
Field components:
- An array.
- Contains the following components: OrderItemId, Quantity.
- ShipFromAddress
Template: AddressT.
- ShipToAddress
Template: AddressT.
- PackageDimensions
Template: GeneralDimensionT.
- Weight
Field components:
-
Uses template:
ShortText. - Contains the following components: Value, Unit.
-
Uses template:
- ShippingService
Field components:
-
Uses template:
ShortText. - Contains the following components: ShippingServiceName, CarrierName, ShippingServiceId, ShippingServiceOfferId, ShipDate, Rate, ShippingServiceOptions, RequiresAdditionalSellerInputs.
-
Uses template:
- Label
Field components:
-
Uses template:
GeneralDimensionT. - Contains the following components: Dimensions, FileContents.
-
Uses template:
- Status
Template: ShortText.
- TrackingId
Template: ShortText.
- CreatedDate
Template: DateTime.
- LastUpdatedDate
Template: DateTime. A read-only field.
- ShippingServiceId
Template: ShortText.
- ShippingServiceOfferId
Template: ShortText.
- HazmatType
Template: ShortText.
- LabelFormatOption
Field components:
- Contains the following components: IncludePackingSlipWithLabel.
- ShipmentLevelSellerInputsList
Field components:
- An array.
- Contains the following components: AdditionalInputFieldName, AdditionalSellerInput.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/mfn/v0/eligibleShippingServices.
The result is extracted from:{{=[response.payload]}}.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify Query in JSON format [{"asin": "B076ZL9PB5", "price": { "currencyCode": "USD", "amount": 6.5 }].
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.get('Query') && JSON.parse(parameters.Query)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#geteligibleshipmentservices.
- [Read old] action
-
Endpoint URL address:
/mfn/v0/eligibleServices.
The result is extracted from:{{=[response.payload]}}.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify Query in JSON format [{"asin": "B076ZL9PB5", "price": { "currencyCode": "USD", "amount": 6.5 }].
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.get('Query') && JSON.parse(parameters.Query)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#geteligibleshipmentservices.
- ShippingServiceList
Field components:
- An array.
- Contains the following components: ShippingServiceName, CarrierName, ShippingServiceId, ShippingServiceOfferId, ShipDate, EarliestEstimatedDeliveryDate, LatestEstimatedDeliveryDate, Rate, ShippingServiceOptions, AvailableLabelFormats, AvailableFormatOptionsForLabel.
- TemporarilyUnavailableCarrierList
Field components:
- An array.
- RejectedShippingServiceList
Field components:
- An array.
- Contains the following components: CarrierName, ShippingServiceName, ShippingServiceId, RejectionReasonCode, RejectionReasonMessage.
- TermsAndConditionsNotAcceptedCarrierList
Field components:
- An array.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/mfn/v0/additionalSellerInputs.
The result is extracted from:{{=[response.payload]}}.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify Query in JSON format [{"asin": "B076ZL9PB5", "price": { "currencyCode": "USD", "amount": 6.5 }].
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.get('Query') && JSON.parse(parameters.Query)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#getadditionalsellerinputs.
- [Read old] action
-
Endpoint URL address:
/mfn/v0/sellerInputs.
The result is extracted from:{{=[response.payload]}}.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify Query in JSON format [{"asin": "B076ZL9PB5", "price": { "currencyCode": "USD", "amount": 6.5 }].
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.get('Query') && JSON.parse(parameters.Query)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/merchant-fulfillment-api-v0-reference#geteligibleshipmentservices.
- ShipmentLevelFields
Field components:
- An array.
- Contains the following components: AdditionalInputFieldName, AdditionalSellerInput.
- ItemLevelFieldsList
Field components:
- An array.
- Contains the following components: Asin, AdditionalInputs.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/definitions/2020-09-01/productTypes.
The result is extracted from:{{=response.productTypes}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplace identifier where the order was placed.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#getlistingsitem.
- name
Template: ShortText.
- marketplaceIds
Template: LongText. A composite field.
- DefinitionProductType
The value is gathered from
/definitions/2020-09-01/productTypes/{{=item.name}}address. The gathered value is processed with{{=response}}expression. Field components:-
Uses template:
SchemaT. - Contains the following components: metaSchema, schema, requirements, requirementsEnforced, propertyGroups, locale, marketplaceIds, productType, productTypeVersion.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/products/pricing/v0/{{=parameters.suffix}}.
The result is extracted from:{{=response.payload}}.The action has the following user-defined parameters:
- suffix: Required. Specify the version of listing items api.
- MarketplaceId: Required. Specify only the Marketplace identifier where the order was placed.
- ItemType: Required. Specify whether ASIN values or seller SKU values are used to identify items.
- Asins: Optional. Specify comma-separated list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.
- Skus: Optional. Specify comma separated list of up to twenty seller SKU values used to identify items in the given marketplace.
The following request parameters will be automatically processed:
-
MarketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getpricing.
- status
Template: ShortText.
- SellerSKU
Template: ShortText.
- Product
Field components:
-
Uses template:
GeneralIdentifierT. - Contains the following components: Identifiers, CompetitivePricing, SalesRankings, Offers.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/products/pricing/v0/listings/{{=parameters.sellerSKU}}/offers.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- MarketplaceId: Required. Specify only the Marketplace identifier where the order was placed.
- ItemCondition: Required. Specify to filters the offer listings based on item condition.
- sellerSKU: Required. Specify the sellerSKU to Identifies an item in the given marketplace.
The following request parameters will be automatically processed:
-
MarketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getlistingoffers.
- [Read item offer] action
-
Endpoint URL address:
/products/pricing/v0/items/{{=parameters.ASIN}}/offers.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- MarketplaceId: Required. Specify only the Marketplace identifier where the order was placed.
- ItemCondition: Required. Specify to filters the offer listings based on item condition.
- ASIN: Required. Specify the Amazon Standard Identification Number (ASIN) of the item.
The following request parameters will be automatically processed:
-
MarketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getitemoffers.
- SKU
Template: ShortText.
- ASIN
Template: ShortText.
- status
Template: ShortText.
- ItemCondition
Template: ShortText.
- Identifier
Field components:
-
Uses template:
ShortText. - Contains the following components: MarketplaceId, ItemCondition, SellerSKU.
-
Uses template:
- Summary
Field components:
-
Uses template:
Money. - Contains the following components: LowestPrices, BuyBoxPrices, NumberOfOffers, BuyBoxEligibleOffers, SalesRankings, ListPrice, TotalOfferCount.
-
Uses template:
- Offers
Field components:
- An array.
- Contains the following components: Shipping, ListingPrice, ShippingTime, SellerFeedbackRating, ShipsFrom, PrimeInformation, SubCondition, SellerId, IsFeaturedMerchant, IsBuyBoxWinner, MyOffer, IsFulfilledByAmazon.
- marketplaceId
Template: ShortText.
- MarketplaceID
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/products/fees/v0/feesEstimate.
The result is extracted from:{{=response.payload.FeesEstimateResult}}.
The action uses POST method.The action has the following user-defined parameters:
- IdType: Required. Specify type of product identifier used in a FeesEstimateByIdRequest.
- IdValue: Required. Specify the item identifier.
- FeesEstimateRequest: Required. Specify FeesEstimateRequest in JSON format.
The following request parameters will be automatically processed:
-
application/json:
{{={ IdType: parameters.IdType, IdValue: parameters.IdValue, FeesEstimateRequest: JSON.parse(parameters.FeesEstimateRequest) } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/product-fees-api-v0-reference#getmyfeesestimates.
- [Read sku] action
-
Endpoint URL address:
/products/fees/v0/listings/{{=parameters.SellerSKU}}/feesEstimate.
The result is extracted from:{{=response.payload.FeesEstimateResult}}.
The action uses POST method.The action has the following user-defined parameters:
- SellerSKU: Required. Specify SellerSKU identifier.
- IdType: Required. Specify type of product identifier used in a FeesEstimateByIdRequest.
- IdValue: Required. Specify the item identifier.
- FeesEstimateRequest: Required. Specify FeesEstimateRequest in JSON format.
The following request parameters will be automatically processed:
-
application/json:
{{={ IdType: parameters.IdType, IdValue: parameters.IdValue, FeesEstimateRequest: JSON.parse(parameters.FeesEstimateRequest) } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/product-fees-api-v0-reference#getmyfeesestimateforsku.
- [Read asin] action
-
Endpoint URL address:
/products/fees/v0/items/{{=parameters.Asin}}/feesEstimate.
The result is extracted from:{{=response.payload.FeesEstimateResult}}.
The action uses POST method.The action has the following user-defined parameters:
- Asin: Required. Specify Amazon Standard Identification Number (ASIN) of the item.
- IdType: Required. Specify type of product identifier used in a FeesEstimateByIdRequest.
- IdValue: Required. Specify the item identifier.
- FeesEstimateRequest: Required. Specify FeesEstimateRequest in JSON format.
The following request parameters will be automatically processed:
-
application/json:
{{={ IdType: parameters.IdType, IdValue: parameters.IdValue, FeesEstimateRequest: JSON.parse(parameters.FeesEstimateRequest) } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/product-fees-api-v0-reference#getmyfeesestimateforasin.
- Status
Template: ShortText.
- FeesEstimateIdentifier
Field components:
-
Uses template:
ShortText. - Contains the following components: MarketplaceId, IdType, SellerId, SellerInputIdentifier, IsAmazonFulfilled, IdValue, PriceToEstimateFees.
-
Uses template:
- FeesEstimate
Field components:
-
Uses template:
DateTime. - Contains the following components: TimeOfFeesEstimation, TotalFeesEstimate, FeeDetailList.
-
Uses template:
- Error
Field components:
-
Uses template:
ShortText. - Contains the following components: Type, Code, Message, Detail.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/fba/inbound/v1/eligibility/itemPreview.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplaces identifiers where the order was placed.
- asin: Required. Specify the ASIN of the item for which you want an eligibility preview.
- program: Required. Specify the program that you want to check eligibility against.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/solicitations-api-v1-reference.
- asin
Template: ShortText.
- marketplaceId
Template: ShortText.
- program
Template: ShortText.
- isEligibleForProgram
Data type: DT_BOOL
- ineligibilityReasonList
Template: LongText. A composite field.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/fba/inventory/v1/summaries.
The result is extracted from:{{=_.map( records.inventorySummaries, function(record) { return _.extend(record, records.granularity); } )}}.The action has the following user-defined parameters:
- MarketplaceIds: Required. Specify only the Marketplaces identifiers where the order was placed.
- granularityType: Required. Specify the ASIN of the item for which you want an eligibility preview.
- granularityId: Required. Specify the program that you want to check eligibility against.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/fbainventory-api-v1-reference#getinventorysummaries.
- asin
Template: ShortText.
- fnSku
Template: ShortText.
- sellerSku
Template: ShortText.
- condition
Template: ShortText.
- granularityType
Template: ShortText.
- granularityId
Template: ShortText.
- inventoryDetails
Field components:
- Contains the following components: fulfillableQuantity, inboundWorkingQuantity, inboundShippedQuantity, inboundReceivingQuantity, reservedQuantity, researchingQuantity, unfulfillableQuantity, futureSupplyQuantity.
- lastUpdatedTime
Template: DateTime. A read-only field.
- productName
Template: ShortText.
- totalQuantity
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/fba/smallAndLight/v1/feePreviews.
The result is extracted from:{{=response.data}}.
The action uses POST method.The action has the following user-defined parameters:
- marketplaceId: Required. Specify the Marketplace identifier.
- Query: Required. Specify Query in JSON format [{"asin": "B076ZL9PB5", "price": { "currencyCode": "USD", "amount": 6.5 }].
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.get('Query') ? { marketplaceId: parameters.marketplaceId, items: JSON.parse(parameters.Query) } : parameters }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/fbasmallandlight-api-v1-reference#getsmallandlightfeepreview.
- totalFees
Template: CurrencyTwo.
- price
Template: CurrencyTwo.
- asin
Template: ShortText.
- feeBreakdown
Field components:
- An array.
- Contains the following components: feeCharge, feeType.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/easyShip/{{=parameters.apiVersion}}/package.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- MarketplaceId: Required. Specify only the Marketplaces identifiers where the order was placed.
- apiVersion: Required. Specify the api version.
- amazonOrderId: Required. Specify an Amazon-defined order identifier, in 3-7-7 format.
The following request parameters will be automatically processed:
-
marketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/easy-ship-api-v2022-03-23-reference#getscheduledpackage.
- [Read slot] action
-
Endpoint URL address:
/easyShip/{{=parameters.apiVersion}}/timeSlot.
The result is extracted from:{{=response.data}}.
The action uses POST method.The action has the following user-defined parameters:
- marketplaceId: Required. Specify the Marketplace identifier.
- apiVersion: Required. Specify the api version.
- amazonOrderId: Required. Specify an Amazon-defined order identifier, in 3-7-7 format.
- packageDimensions: Required. Specify the dimensions of the scheduled package in JSON format.
- packageWeight: Required. Specify the weight of the scheduled package in JSON format.
The following request parameters will be automatically processed:
-
application/json:
{{={ marketplaceId : parameters.marketplaceId, amazonOrderId : parameters.amazonOrderId, packageDimensions: JSON.parse(parameters.packageDimensions), packageWeight: JSON.parse(parameters.packageWeight) } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/easy-ship-api-v2022-03-23-reference#listhandoverslots.
- [Create] action
-
Endpoint URL address:
/easyShip/{{=parameters.apiVersion}}/package.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
- marketplaceId: Required. Specify the Marketplace identifier.
- amazonOrderId: Required. Specify an Amazon-defined order identifier, in 3-7-7 format.
The following request parameters will be automatically processed:
-
application/json:
{{={ CreateScheduledPackageRequest : { marketplaceId: parameters.marketplaceId, amazonOrderId : parameters.amazonOrderId, packageDetails: item } } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/easy-ship-api-v2022-03-23-reference#createscheduledpackage.
- [Update] action
-
Endpoint URL address:
/easyShip/{{=parameters.apiVersion}}/package.
The action uses PATCH method.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
- marketplaceId: Required. Specify the Marketplace identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ UpdateScheduledPackagesRequest: { marketplaceId : parameters.marketplaceId, updatePackageDetailsList: item } } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/easy-ship-api-v2022-03-23-reference#updatescheduledpackages.
- amazonOrderId
A key field. Template: ShortText.
- scheduledPackageId
Field components:
-
Uses template:
ShortText. - Contains the following components: amazonOrderId, packageId.
-
Uses template:
- packageDimensions
Template: ShippingDimensionT.
- packageWeight
Template: UnitValueT.
- packageTimeSlot
Field components:
-
Uses template:
ShortText. - Contains the following components: slotId, startTime, endTime, handoverMethod.
-
Uses template:
- packageStatus
Template: ShortText.
- packageIdentifier
Template: ShortText.
- invoice
Field components:
-
Uses template:
ShortText. - Contains the following components: invoiceNumber, invoiceDate.
-
Uses template:
- trackingDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: trackingId.
-
Uses template:
- packageItems
Field components:
- An array.
- Contains the following components: orderItemId, orderItemSerialNumbers.
- timeSlots
Field components:
- An array.
- Contains the following components: handoverMethod, slotId, startTime, endTime.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/catalog/v0/items.
The result is extracted from:{{=response.payload.Items}}.The action has the following user-defined parameters:
- MarketplaceId: Required. Specify only the Marketplace identifier for which items are returned.
- Query: Required. Specify Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'.
The following request parameters will be automatically processed:
-
MarketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v0-reference#listcatalogitems.
- [Read single] action
-
Endpoint URL address:
/easyShip/{{=parameters.apiVersion}}/timeSlot.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- MarketplaceId: Required. Specify only the Marketplace identifier for which items are returned.
- asin: Required. Specify the Amazon Standard Identification Number (ASIN) of the item.
The following request parameters will be automatically processed:
-
MarketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v0-reference#getcatalogitem.
- Identifiers
Template: GeneralIdentifierT.
- AttributeSets
Field components:
- An array.
- Contains the following components: Actor, Artist, Author, Director, DisplaySize, Feature, Format, GemType, MaterialType, MediaType, OperatingSystem, Platform, AspectRatio, AudienceRating, BackFinding, BandMaterialType, Binding, BlurayRegion, Brand, CeroAgeRating, ChainType, ClaspType, Color, CpuManufacturer, CpuSpeed, CpuType, Department, Edition, EpisodeSequence, EsrbAgeRating, Flavor, Genre, GolfClubFlex, GolfClubLoft, HandOrientation, HardDiskInterface, HardDiskSize, HardwarePlatform, HazardousMaterialType, ItemDimensions, IsAdultProduct, IsAutographed, IsEligibleForTradeIn, IsMemorabilia, IssuesPerYear, ItemPartNumber, Label, Languages, LegalDisclaimer, ListPrice, Manufacturer, ManufacturerMaximumAge, ManufacturerMinimumAge, ManufacturerPartsWarrantyDescription, MetalStamp, MetalType, Model.
- Relationships
Field components:
- An array.
- Contains the following components: Edition, GolfClubFlex, Size, GolfClubLoft, TotalDiamondWeight, TotalGemWeight, Color, Flavor, HandOrientation, HardwarePlatform, MetalType, Model, ProductTypeSubcategory, GemType, MaterialType, OperatingSystem, RingSize, ShaftMaterial, Scent, size, SizePerPearl, PackageQuantity, ItemDimensions.
- SalesRankings
Field components:
- An array.
-
Uses template:
SaleRankingT.
- catalogCategories
The value is gathered from
/catalog/v0/categoriesaddress. The gathered value is processed with{{=response.payload}}expression. Field components:- An array.
- Contains the following components: ProductCategoryId, ProductCategoryName, parent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/catalog/{{=parameters.apiVersion}}/items.
The result is extracted from:{{=response.items}}.
The result is paginated.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
- MarketplaceIds: Required. Specify only the Marketplace identifier for which items are returned.
- identifiers: Specify comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.
- keywords: Specify comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}} -
pageToken:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}} -
MaxResultsPerPage:
{{=undefined}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference#searchcatalogitems.
- [Read single] action
-
Endpoint URL address:
/catalog/{{=parameters.apiVersion}}/items/{{=parameters.asin}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
- MarketplaceIds: Required. Specify only the Marketplace identifier for which items are returned.
- asin: Required. Specify the Amazon Standard Identification Number (ASIN) of the item.
The following request parameters will be automatically processed:
-
marketplaceIds:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-reference#getcatalogitem.
- asin
Template: ShortText.
- attributes
Field components:
-
Uses template:
CatalogItemAT. - Contains the following components: total_hdmi_ports, resolution, item_weight, product_subcategory, bullet_point, item_dimensions, brand, generic_keyword, control_method, item_package_dimensions, image_aspect_ratio, part_number, includes_remote, style, item_type_name, battery, image_contrast_ratio, manufacturer, number_of_boxes, total_usb_ports, model_number, supplier_declared_dg_hz_regulation, num_batteries, california_proposition_65, display, item_name, list_price, batteries_required, includes_rechargable_battery, product_site_launch_date, product_category, batteries_included, connectivity_technology, included_components, specification_met, parental_control_technology, power_consumption, cpsia_cautionary_statement, item_type_keyword, number_of_items, warranty_description, max_resolution, color, screen_surface_description, item_package_weight, speaker_type, supported_internet_services, tuner_technology, controller_type, special_feature, wireless_communication_technology, model_year, power_source_type, street_date, mounting_type, refresh_rate.
-
Uses template:
- dimensions
Field components:
- An array.
- Contains the following components: marketplaceId, item, package.
- identifiers
Field components:
- An array.
- Contains the following components: marketplaceId, identifiers.
- images
Field components:
- An array.
- Contains the following components: marketplaceId, images.
- productTypes
Field components:
- An array.
- Contains the following components: marketplaceId, productType.
- salesRanks
Field components:
- An array.
- Contains the following components: marketplaceId, classificationRanks, displayGroupRanks.
- summaries
Field components:
- An array.
- Contains the following components: marketplaceId, brand, browseClassification, color, itemClassification, itemName, manufacturer, modelNumber, packageQuantity, partNumber, size, style, websiteDisplayGroup, websiteDisplayGroupName.
- variations
Field components:
- An array.
- Contains the following components: marketplaceId, asins, type.
- relationships
Field components:
- An array.
- Contains the following components: marketplaceId, relationships.
- vendorDetails
Field components:
- An array.
- Contains the following components: marketplaceId, brandCode, manufacturerCode, manufacturerCodeParent, productCategory, productGroup, productSubcategory, replenishmentCategory.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/reports/2021-06-30/reports.
The result is extracted from:{{=response.reports}}.The action has the following user-defined parameters:
- ReportType: Specify report type used to filter reports. When parameter is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) may also be provided.
The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
pageSize:
{{=(parameters.iterator) ? undefined : parameters.get('batchSize')}} -
reportTypes:
{{=(parameters.iterator) ? undefined : ASP.UI.getReportTypeList(parameters)}} -
_includeUserParameters:
{{=(parameters.iterator) ? undefined : parameters}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#getreports.
- [Read single] action
-
Endpoint URL address:
/reports/2021-06-30/reports/{{=parameters.ReportId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- ReportId: Required. Specify the report identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v0-reference#getcatalogitem.
- [Create] action
-
Endpoint URL address:
/reports/2021-06-30/reports.Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#createreport.
- [Delete] action
-
Endpoint URL address:
/reports/2021-06-30/reports/{{=item.reportId}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#cancelreport.
- reportId
A key field. Template: ShortText.
- reportType
Template: ShortText.
- processingEndTime
Template: ShortText.
- processingStatus
Template: ShortText.
- marketplaceIds
Template: LongText. A composite field.
- reportOptions
Template: LongText. A composite field.
- dataEndTime
Template: DateTime.
- createdTime
Template: DateTime. A read-only field.
- processingStartTime
Template: ShortText.
- reportScheduleId
Template: ShortText.
- dataStartTime
Template: DateTime.
- reportDocumentId
Template: ShortText.
- downloadReport
Data type: DT_IMAGE The gathered value is processed with
{{=ASP.getReport(item, parameters)}}expression.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/reports/2021-06-30/documents/{{=ASP.getReportDocument(parameters.ReportId)}}.
The result is extracted from:{{=ASP.getReportResult(response).data}}.The action has the following user-defined parameters:
- ReportType: Required. Specify report type used to filter reports. When parameter is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) may also be provided.
- ReportId: Required. Specify the report identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#getreportdocument.
- [External]
-
The external fields URL address:
/reports/2021-06-30/documents/{{=ASP.getReportDocument(parameters.ReportId)}}. The external fields list is extracted from:{{=ASP.getReportResult(response, true).fields}}.- {{=external.name}}
Template: {{=external.template}}.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/reports/{{=parameters.apiVersion}}/schedules.
The result is extracted from:{{=response.reportSchedules}}.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
- ReportType: Specify report type to filter report schedules.
The following request parameters will be automatically processed:
-
reportTypes:
{{=ASP.UI.getReportTypeList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#getreportschedules.
- [Read single] action
-
Endpoint URL address:
/reports/{{=parameters.apiVersion}}/schedules/{{=parameters.reportScheduleId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
- reportScheduleId: Required. Specify the report schedule identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#getreportschedule.
- [Create] action
-
Endpoint URL address:
/reports/{{=parameters.apiVersion}}/schedules.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#createreportschedule.
- [Delete] action
-
Endpoint URL address:
/reports/{{=parameters.apiVersion}}/schedules/{{=item.reportScheduleId}}.The action has the following user-defined parameters:
- apiVersion: Required. Specify the api version.
Documentation: https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference#cancelreportschedule.
- reportType
Template: ShortText.
- processingEndTime
Template: DateTime.
- reportDocumentId
Template: ShortText.
- processingStatus
Template: ShortText.
- marketplaceIds
Template: LongText. A composite field.
- reportOptions
Template: LongText. A composite field.
- reportId
A key field. Template: ShortText.
- dataEndTime
Template: DateTime.
- createdTime
Template: DateTime. A read-only field.
- processingStartTime
Template: ShortText.
- reportScheduleId
A key field. Template: ShortText.
- dataStartTime
Template: DateTime.
- nextReportCreationTime
Template: DateTime.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/notifications/v1/destinations.
The result is extracted from:{{=response.payload}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#getdestinations.
- [Read single] action
-
Endpoint URL address:
/notifications/v1/destinations/{{=parameters.destinationId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- destinationId: Required. Specify the destination identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#getdestinationresponse.
- [Create] action
-
Endpoint URL address:
/notifications/v1/destinations.Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#createdestination.
- [Delete] action
-
Endpoint URL address:
/notifications/v1/destinations/{{=item.destinationId}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#deletedestination.
- destinationId
A key field. Template: ShortText.
- name
Template: ShortText.
- resource
Field components:
-
Uses template:
ResourceT. - Contains the following components: sqs.
-
Uses template:
- resourceSpecification
Field components:
-
Uses template:
ResourceT. - Contains the following components: sqs, eventBridge.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/notifications/v1/subscriptions/{{=parameters.notificationType}}.
The result is extracted from:{{=response.payload}}.The action has the following user-defined parameters:
- notificationType: Required. Specify the notification type.
Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#getsubscription.
- [Read single] action
-
Endpoint URL address:
/notifications/v1/subscriptions/{{=parameters.notificationType}}/{{=parameters.subscriptionId}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- notificationType: Required. Specify the notification type.
- notificationType: Required. Specify the notification type.
Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#subscription.
- [Create] action
-
Endpoint URL address:
/notifications/v1/subscriptions/{{=parameters.notificationType}}.The action has the following user-defined parameters:
- notificationType: Required. Specify the notification type.
Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#createsubscription.
- [Delete] action
-
Endpoint URL address:
/notifications/v1/subscriptions/{{=parameters.notificationType}}/{{=item.id}}.The action has the following user-defined parameters:
- notificationType: Required. Specify the notification type.
Documentation: https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-reference#deletesubscriptionbyid.
- subscriptionId
A key field. Template: ShortText.
- payloadVersion
Template: ShortText.
- destinationId
Template: ShortText.
- processingDirective
Field components:
- Contains the following components: eventFilter.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/feeds/2021-06-30/feeds.
The result is extracted from:{{=response.feeds}}.
The result is paginated.The action has the following user-defined parameters:
- feedTypes: Required. Specify the feed type.
The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
pageSize:
{{=(parameters.iterator) ? undefined : parameters.get('batchSize')}} -
feedTypes:
{{=(parameters.iterator) ? undefined : parameters.feedTypes}} -
_includeUserParameters:
{{=(parameters.iterator) ? undefined : parameters}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#getfeeds.
- [Read single] action
-
Endpoint URL address:
/feeds/2021-06-30/feeds/{{=parameters.feedId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- feedId: Required. Specify the report identifier.
Documentation: https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#feed.
- [Create] action
-
Endpoint URL address:
.
The result is extracted from:{{=ASP.createFeed(item)}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-use-case-guide.
- [Delete] action
-
Endpoint URL address:
/feeds/2021-06-30/feeds/{{=item.feedId}}.Documentation: https://developer-docs.amazon.com/sp-api/docs/feeds-api-v2021-06-30-reference#cancelfeed.
- feedId
A key field. Template: ShortText.
- processingEndTime
Template: DateTime.
- processingStatus
Template: ShortText.
- marketplaceIds
Template: LongText. A composite field.
- feedOptions
Template: LongText. A composite field.
- inputFeedDocumentId
Template: ShortText.
- feedType
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- processingStartTime
Template: DateTime.
- resultFeedDocumentId
Template: ShortText.
- feedContent
Data type: DT_IMAGE The gathered value is processed with
{{=ASP.getReport(item, parameters)}}expression.
Based on resource template General.
- [Update] action
-
Endpoint URL address:
/vendor/directFulfillment/inventory/v1/warehouses/{{=parameters.warehouseId}}/items.
The action uses POST method.The action has the following user-defined parameters:
- warehouseId: Required. Specify the identifier for the warehouse for which to update inventory.
The following request parameters will be automatically processed:
-
application/json:
{{={ inventory : item } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-inventory-api-v1-reference#submitinventoryupdate.
- sellingParty
Template: GeneralPartyT.
- isFullUpdate
Data type: DT_BOOL
- items
Field components:
- An array.
-
Uses template:
VendorItemT.
- transactionId
A key field. Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/directFulfillment/transactions/v1/transactions/{{=parameters.transactionId}}.
The result is extracted from:{{=[response.payload.transactionStatus]}}.The action has the following user-defined parameters:
- transactionId: Required. Specify the identifier for the warehouse for which to update inventory.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-transactions-api-v1-reference#gettransactionstatus.
- transactionId
A key field. Template: ShortText.
- errors
Field components:
- An array.
- Contains the following components: code, message.
- status
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/directFulfillment/orders/v1/purchaseOrders.
The result is extracted from:{{=response.payload.orders}}.
The result is paginated.The action has the following user-defined parameters:
- createdAfter: Required. Specify Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
- createdBefore: Required. Specify Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-transactions-api-v1-reference#gettransactionstatus.
- [Read single] action
-
Endpoint URL address:
/vendor/directFulfillment/orders/v1/purchaseOrders/{{=parameters.purchaseOrderNumber}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- purchaseOrderNumber: Required. Specify the order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-orders-api-v1-reference#getorder.
- purchaseOrderNumber
A key field. Template: ShortText.
- orderDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: customerOrderNumber, orderDate, orderStatus, shipmentDetails, taxTotal, sellingParty, shipFromParty, shipToParty, billToParty, items.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/directFulfillment/shipping/v1/shippingLabels.
The result is extracted from:{{=response.payload.shippingLabels}}.
The result is paginated.The action has the following user-defined parameters:
- createdAfter: Required. Specify Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
- createdBefore: Required. Specify Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-v1-reference#getshippinglabels.
- [Read single] action
-
Endpoint URL address:
/vendor/directFulfillment/shipping/v1/shippingLabels/{{=parameters.purchaseOrderNumber}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- purchaseOrderNumber: Required. Specify the purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-v1-reference#getshippinglabel.
- purchaseOrderNumber
A key field. Template: ShortText.
- sellingParty
Template: GeneralPartyT.
- shipFromParty
Template: GeneralPartyT.
- labelFormat
Template: ShortText.
- labelData
Field components:
- An array.
- Contains the following components: packageIdentifier, trackingNumber, shipMethod, shipMethodName, content.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/directFulfillment/shipping/v1/shippingLabels.
The result is extracted from:{{=response.payload.customerInvoices}}.
The result is paginated.The action has the following user-defined parameters:
- createdAfter: Required. Specify Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
- createdBefore: Required. Specify Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-v1-reference#getcustomerinvoices.
- [Read single] action
-
Endpoint URL address:
/vendor/directFulfillment/shipping/v1/customerInvoices/{{=parameters.purchaseOrderNumber}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- purchaseOrderNumber: Required. Specify the purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-v1-reference#getcustomerinvoice.
- purchaseOrderNumber
A key field. Template: ShortText.
- content
Data type: DT_WSTR ( length 2000 ) The gathered value is processed with
{{=Convert.FromBase64String(value.readAll())}}expression.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/directFulfillment/shipping/v1/packingSlips.
The result is extracted from:{{=response.payload.packingSlips}}.
The result is paginated.The action has the following user-defined parameters:
- createdAfter: Required. Specify Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
- createdBefore: Required. Specify Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-v1-reference#getpackingslips.
- [Read single] action
-
Endpoint URL address:
/vendor/directFulfillment/shipping/v1/packingSlips/{{=parameters.purchaseOrderNumber}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- purchaseOrderNumber: Required. Specify the purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-v1-reference#getpackingslip.
- purchaseOrderNumber
A key field. Template: ShortText.
- contentType
Template: ShortText.
- content
Data type: DT_WSTR ( length 2000 ) The gathered value is processed with
{{=Convert.FromBase64String(value.readAll())}}expression.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/vendor/directFulfillment/payments/v1/invoices.The following request parameters will be automatically processed:
-
application/json:
{{={ invoices : [item] } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-payments-api-v1-reference#submitinvoice.
-
application/json:
- invoiceNumber
Template: ShortText.
- invoiceDate
Template: DateTime.
- remitToParty
Template: PartyT. Field components:
-
Uses template:
BillRemitPartyDetailT. - Contains the following components: taxRegistrationDetails.
-
Uses template:
- shipFromParty
Template: GeneralPartyT.
- billToParty
Template: PartyT. Field components:
-
Uses template:
BillRemitPartyDetailT. - Contains the following components: taxRegistrationDetails.
-
Uses template:
- shipToCountryCode
Template: ShortText.
- paymentTermsCode
Template: ShortText.
- invoiceTotal
Template: CurrencyTwo.
- taxTotals
Field components:
- An array.
-
Uses template:
TaxDetailsT.
- items
Field components:
- An array.
-
Uses template:
VendorItemT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/vendor/payments/v1/invoices.The following request parameters will be automatically processed:
-
application/json:
{{={ invoices : [item] } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-invoices-api-v1-reference.
-
application/json:
- invoiceType
Template: ShortText.
- id
Template: ShortText.
- date
Template: DateTime.
- remitToParty
Template: PartyT. Field components:
-
Uses template:
BillRemitPartyDetailT. - Contains the following components: taxRegistrationDetails.
-
Uses template:
- shipToParty
Template: PartyT.
- shipFromParty
Template: PartyT.
- billToParty
Template: PartyT. Field components:
-
Uses template:
BillRemitPartyDetailT. - Contains the following components: taxRegistrationDetails.
-
Uses template:
- paymentTerms
Field components:
-
Uses template:
ShortText. - Contains the following components: type, discountPercent, discountDueDays, netDueDays.
-
Uses template:
- invoiceTotal
Template: CurrencyTwo.
- taxDetails
Field components:
- An array.
-
Uses template:
TaxDetailsT.
- chargeDetails
Field components:
- An array.
-
Uses template:
ChargeDetailT.
- items
Field components:
- An array.
-
Uses template:
VendorItemT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/vendor/shipping/v1/shipmentConfirmations.The following request parameters will be automatically processed:
-
application/json:
{{={ shipmentConfirmations : [item] } }}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-shipments-api-v1-reference.
-
application/json:
- shipmentIdentifier
Template: ShortText.
- shipmentConfirmationType
Template: ShortText.
- shipmentType
Template: ShortText.
- shipmentStructure
Template: ShortText.
- transportationDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: transportationMode, billOfLadingNumber.
-
Uses template:
- shipmentConfirmationDate
Template: DateTime.
- shippedDate
Template: DateTime.
- estimatedDeliveryDate
Template: DateTime.
- sellingParty
Template: GeneralPartyT.
- shipFromParty
Template: PartyT.
- shipToParty
Template: GeneralPartyT.
- shipmentMeasurements
Field components:
-
Uses template:
AmountUnitMeasureT. - Contains the following components: grossShipmentWeight, shipmentVolume, palletCount.
-
Uses template:
- shippedItems
Field components:
- An array.
- Contains the following components: itemSequenceNumber, vendorProductIdentifier, itemDetails.
- cartons
Field components:
- An array.
- Contains the following components: cartonIdentifiers, cartonSequenceNumber, items.
- pallets
Field components:
- An array.
- Contains the following components: palletIdentifiers, tier, block, dimensions, weight, cartonReferenceDetails.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/transactions/v1/transactions/{{=parameters.transactionId}}.
The result is extracted from:{{=[response.payload.transactionStatus]}}.The action has the following user-defined parameters:
- transactionId: Required. Specify GUID provided by Amazon in the 'transactionId' field in response to the post request of a specific transaction.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-transaction-status-api-v1-reference#gettransaction.
- transactionId
A key field. Template: ShortText.
- errors
Field components:
- An array.
- Contains the following components: code, message.
- status
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/vendor/orders/v1/purchaseOrders.
The result is extracted from:{{=response.payload.orders}}.
The result is paginated.The following request parameters will be automatically processed:
-
nextToken:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-orders-api-v1-reference#getpurchaseorders.
-
nextToken:
- [Read single] action
-
Endpoint URL address:
/vendor/orders/v1/purchaseOrders/{{=parameters.purchaseOrderNumber}}.
The result is extracted from:{{=[response.payload]}}.The action has the following user-defined parameters:
- purchaseOrderNumber: Required. Specify the order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
Documentation: https://developer-docs.amazon.com/sp-api/docs/vendor-orders-api-v1-reference#getpurchaseorder.
- purchaseOrderNumber
A key field. Template: ShortText.
- purchaseOrderState
Template: ShortText.
- orderDetails
Field components:
-
Uses template:
DateTime. - Contains the following components: purchaseOrderDate, purchaseOrderChangedDate, purchaseOrderStateChangedDate, purchaseOrderType, importDetails, dealCode, paymentMethod, buyingParty, sellingParty, shipToParty, billToParty, taxInfo.
-
Uses template:
- deliveryWindow
Template: ShortText.
- items
Field components:
- An array.
-
Uses template:
VendorItemT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/aplus/2020-11-01/contentDocuments.
The result is extracted from:{{=response.contentMetadataRecords}}.
The result is paginated.The action has the following user-defined parameters:
- NarketplaceId: Required. Specify the identifier for the marketplace where the A+ Content is published.
- identifiers: Specify comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.
- keywords: Specify comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.
The following request parameters will be automatically processed:
-
marketplaceId:
{{=ASP.UI.getMarketList(parameters)}} -
pageToken:
{{=parameters.iterator}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/selling-partner-api-for-a-content-management#searchcontentdocuments.
- [Read single] action
-
Endpoint URL address:
/aplus/2020-11-01/contentDocuments/{{=parameters.contentReferenceKey}}.
The result is extracted from:{{=[response.contentRecord]}}.The action has the following user-defined parameters:
- contentReferenceKey: Required. Specify the identifier for the marketplace where the A+ Content is published.
- MarketplaceId: Required. Specify only the Marketplace identifier for which items are returned.
The following request parameters will be automatically processed:
-
marketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/selling-partner-api-for-a-content-management#getcontentdocument.
- [Create] action
-
Endpoint URL address:
/aplus/2020-11-01/contentDocuments.The action has the following user-defined parameters:
- MarketplaceId: Required. Specify only the Marketplace identifier for which items are returned.
The following request parameters will be automatically processed:
-
marketplaceId:
{{=ASP.UI.getMarketList(parameters)}}
Documentation: https://developer-docs.amazon.com/sp-api/docs/selling-partner-api-for-a-content-management#createcontentdocument.
- contentReferenceKey
A key field. Template: ShortText.
- contentMetadata
Field components:
-
Uses template:
ShortText. - Contains the following components: name, marketplaceId, status, badgeSet, updateTime.
-
Uses template:
- contentDocument
Field components:
-
Uses template:
ShortText. - Contains the following components: name, contentType, contentSubType, locale, contentModuleList.
-
Uses template:
- asin
The value is gathered from
/aplus/2020-11-01/contentDocuments/{{=item.contentReferenceKey}}/asinsaddress. The gathered value is processed with{{=response.asinMetadataSet}}expression. Field components:- An array.
- Contains the following components: asin, badgeSet, parent, title, imageUrl, contentReferenceKeySet.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
NextToken:
{{=parameters.iterator}} -
MaxResultsPerPage:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
NextToken:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Money
Field components:
-
Uses template:
ShortText. - Contains the following components: CurrencyCode, Amount.
-
Uses template:
- Currency
Field components:
-
Uses template:
ShortText. - Contains the following components: CurrencyCode, CurrencyAmount.
-
Uses template:
- CurrencyTwo
Field components:
-
Uses template:
ShortText. - Contains the following components: amount, currencyCode.
-
Uses template:
- AddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: Name, AddressLine1, City, County, StateOrRegion, PostalCode, CountryCode, Phone, AddressType.
-
Uses template:
- VendorAddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, addressLine1, addressLine2, addressLine3, city, county, district, stateOrRegion, postalCode, countryCode.
-
Uses template:
- ShippingAddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: addressLine1, name, addressLine2, addressLine3, stateOrRegion, city, countryCode, postalCode, email, copyEmail, phoneNumber.
-
Uses template:
- TaxClassificationT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, value.
-
Uses template:
- TaxCollectionT
Field components:
-
Uses template:
ShortText. - Contains the following components: Model, ResponsibleParty.
-
Uses template:
- ProductInfoT
Field components:
- Contains the following components: NumberOfItems.
- BuyerTaxInfoT
Field components:
-
Uses template:
ShortText. - Contains the following components: CompanyLegalName, TaxingRegion, TaxClassifications.
-
Uses template:
- BuyerInfoT
Field components:
-
Uses template:
ShortText. - Contains the following components: BuyerEmail, BuyerName, BuyerCounty, PurchaseOrderNumber, AmazonOrderId, BuyerTaxInfo.
-
Uses template:
- BuyerRequestedCancelT
Field components:
-
Uses template:
ShortText. - Contains the following components: IsBuyerRequestedCancel, BuyerCancelReason.
-
Uses template:
- UnitValueT
Field components:
-
Uses template:
ShortText. - Contains the following components: value, unit.
-
Uses template:
- UnitsValuesT
Field components:
-
Uses template:
ShortText. - Contains the following components: value, Units.
-
Uses template:
- StartEndDateT
Field components:
-
Uses template:
DateTime. - Contains the following components: start, end.
-
Uses template:
- ShippingItemT
Field components:
-
Uses template:
ShortText. - Contains the following components: title, unitWeight, quantity, unitPrice.
-
Uses template:
- ShippingDimensionT
Field components:
-
Uses template:
ShortText. - Contains the following components: height, length, width, unit, identifier, unitOfMeasure.
-
Uses template:
- GeneralDimensionT
Field components:
-
Uses template:
ShortText. - Contains the following components: Length, Width, Height, Unit.
-
Uses template:
- ShippingContainerT
Field components:
-
Uses template:
ShortText. - Contains the following components: containerReferenceId, items, dimensions, containerType, weight, value.
-
Uses template:
- ShippingPromiseT
Field components:
-
Uses template:
StartEndDateT. - Contains the following components: deliveryWindow, receiveWindow.
-
Uses template:
- ItemChargeListT
Field components:
-
Uses template:
ShortText. - Contains the following components: ChargeType, ChargeAmount.
-
Uses template:
- ItemFeeListT
Field components:
-
Uses template:
ShortText. - Contains the following components: FeeType, FeeAmount.
-
Uses template:
- TaxWithHeldListT
Field components:
-
Uses template:
ShortText. - Contains the following components: TaxCollectionModel, TaxesWithheld.
-
Uses template:
- RemovalShipmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: RemovalShipmentItemId, TaxCollectionModel, FulfillmentNetworkSKU, AdjustedQuantity, RevenueAdjustment, TaxAmountAdjustment, TaxWithheldAdjustment.
-
Uses template:
- PromotionListT
Field components:
-
Uses template:
ShortText. - Contains the following components: PromotionType, PromotionId, PromotionAmount.
-
Uses template:
- ShipmentItemListT
Field components:
-
Uses template:
ShortText. - Contains the following components: SellerSKU, OrderItemId, OrderAdjustmentItemId, QuantityShipped, CostOfPointsReturned, CostOfPointsGranted, ItemChargeList, ItemChargeAdjustmentList, ItemFeeList, ItemFeeAdjustmentList, ItemTaxWithheldList, PromotionList, PromotionAdjustmentList.
-
Uses template:
- ShipmentEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, MarketplaceName, PostedDate, ShipmentItemList.
-
Uses template:
- RefundEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, MarketplaceName, PostedDate, ShipmentItemAdjustmentList, ShipmentItemList.
-
Uses template:
- GuaranteeClaimEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, MarketplaceName, PostedDate, ShipmentItemList.
-
Uses template:
- ChargebackEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: SellerSKU, OrderItemId, OrderAdjustmentItemId, QuantityShipped, CostOfPointsReturned, CostOfPointsGranted, ItemChargeList, ItemChargeAdjustmentList, ItemFeeList, ItemFeeAdjustmentList, ItemTaxWithheldList, PromotionList, PromotionAdjustmentList.
-
Uses template:
- PayWithAmazonEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: SellerOrderId, TransactionPostedDate, Charge, FeeList, FulfillmentChannel, StoreName.
-
Uses template:
- ServiceProviderCreditEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: ProviderTransactionType, SellerOrderId, MarketplaceId, MarketplaceCountryCode, SellerId, SellerStoreName, ProviderId, ProviderStoreName, TransactionAmount, TransactionCreationDate.
-
Uses template:
- RetrochargeEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: RetrochargeEventType, AmazonOrderId, PostedDate, BaseTax, ShippingTax, MarketplaceName, RetrochargeTaxWithheldList.
-
Uses template:
- RentalTransactionEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, RentalEventType, ExtensionLength, PostedDate, RentalChargeList, RentalFeeList, MarketplaceName, RentalInitialValue, RentalReimbursement, RentalTaxWithheldList.
-
Uses template:
- ProductAdsPaymentEventList
Field components:
-
Uses template:
DateTime. - Contains the following components: postedDate, transactionType, invoiceId, baseValue, taxValue, transactionValue.
-
Uses template:
- ServiceFeeEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, FeeReason, FeeList, SellerSKU, FnSKU, FeeDescription, ASIN.
-
Uses template:
- AdjustmentEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AdjustmentType, PostedDate, AdjustmentAmount.
-
Uses template:
- ImagingServicesFeeEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: ImagingRequestBillingItemID, ASIN, PostedDate, FeeList.
-
Uses template:
- NetworkComminglingTransactionEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: TransactionType, PostedDate, NetCoTransactionID, SwapReason, ASIN, MarketplaceId, TaxExclusiveAmount, TaxAmount.
-
Uses template:
- AffordabilityExpenseReversalEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, PostedDate, MarketplaceId, TransactionType, BaseExpense, TaxTypeCGST, TaxTypeSGST, TaxTypeIGST, TotalExpense.
-
Uses template:
- TrialShipmentEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, FinancialEventGroupId, PostedDate, SKU, FeeList.
-
Uses template:
- TaxWithholdingEventList
Field components:
-
Uses template:
DateTime. - Contains the following components: PostedDate, BaseAmount, WithheldAmount, TaxWithholdingPeriod.
-
Uses template:
- SellerDealPaymentEventList
Field components:
-
Uses template:
DateTime. - Contains the following components: PostedDate, EnrollmentId, ParentASIN, FeeComponent, ChargeComponent, TotalAmount.
-
Uses template:
- DebtRecoveryEventList
Field components:
-
Uses template:
DateTime. - Contains the following components: GroupBeginDate, GroupEndDate, RecoveryAmount, OriginalAmount.
-
Uses template:
- LoanServicingEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: TransactionType, PostedDate, NetCoTransactionID, SwapReason, ASIN, MarketplaceId, TaxExclusiveAmount, TaxAmount.
-
Uses template:
- SAFETReimbursementEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: quantity, productDescription, itemChargeList.
-
Uses template:
- SellerReviewEnrollmentPaymentEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, FeeReason, FnSKU, SellerSKU, ASIN, FeeDescription, FeeList.
-
Uses template:
- FBALiquidationEventList
Field components:
-
Uses template:
DateTime. - Contains the following components: PostedDate, OriginalRemovalOrderId, LiquidationProceedsAmount, LiquidationFeeAmount.
-
Uses template:
- CouponPaymentEventList
Field components:
-
Uses template:
DateTime. - Contains the following components: PostedDate, CouponId, SellerCouponDescription, ClipOrRedemptionCount, PaymentEventId, ChargeComponent, FeeComponent, TotalAmount.
-
Uses template:
- AffordabilityExpenseEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: AmazonOrderId, PostedDate, MarketplaceId, TransactionType, BaseExpense, TaxTypeCGST, TaxTypeSGST, TaxTypeIGST, TotalExpense.
-
Uses template:
- RemovalShipmentAdjustmentEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: RemovalShipmentItemId, TaxCollectionModel, FulfillmentNetworkSKU, AdjustedQuantity, RevenueAdjustment, TaxAmountAdjustment, TaxWithheldAdjustment.
-
Uses template:
- RemovalShipmentEventList
Field components:
-
Uses template:
ShortText. - Contains the following components: RemovalShipmentItemId, TaxCollectionModel, FulfillmentNetworkSKU, Quantity, Revenue, FeeAmount, TaxAmount, TaxWithheld.
-
Uses template:
- PriceT
Field components:
-
Uses template:
Money. - Contains the following components: LandedPrice, ListingPrice, Shipping.
-
Uses template:
- SaleRankingT
Field components:
-
Uses template:
ShortText. - Contains the following components: ProductCategoryId, Rank.
-
Uses template:
- PropertyGroupT
Field components:
-
Uses template:
ShortText. - Contains the following components: title, description, propertyNames.
-
Uses template:
- LinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: resource, verb.
-
Uses template:
- SchemaT
Field components:
-
Uses template:
LinkT. - Contains the following components: link, checksum.
-
Uses template:
- SolicitationLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: href, name.
-
Uses template:
- LabelSpecificationT
Field components:
-
Uses template:
ShortText. - Contains the following components: labelFormat, labelStockSize.
-
Uses template:
- GeneralIdentifierT
Field components:
- Contains the following components: MarketplaceASIN, SKUIdentifier.
- RankT
Field components:
-
Uses template:
ShortText. - Contains the following components: classificationId, title, link, rank.
-
Uses template:
- GeneralCatalogAttributeT
Field components:
-
Uses template:
ShortText. - Contains the following components: language_tag, value, marketplace_id.
-
Uses template:
- CatalogItemDimensionT
Field components:
-
Uses template:
UnitValueT. - Contains the following components: height, length, weight, width, marketplace_id.
-
Uses template:
- CatalogItemAttributeT
Field components:
-
Uses template:
ShortText. - Contains the following components: value, marketplace_id.
-
Uses template:
- AmountUnitMeasureT
Field components:
-
Uses template:
ShortText. - Contains the following components: amount, unitOfMeasure, unitSize, value.
-
Uses template:
- TaxDetailsT
Field components:
-
Uses template:
ShortText. - Contains the following components: taxType, taxRate, taxAmount, taxableAmount, type.
-
Uses template:
- PartyT
Field components:
-
Uses template:
ShortText. - Contains the following components: partyId, address.
-
Uses template:
- GeneralPartyT
Field components:
-
Uses template:
ShortText. - Contains the following components: partyId.
-
Uses template:
- TaxRegisterationDetailT
Field components:
-
Uses template:
ShortText. - Contains the following components: taxRegistrationType, taxRegistrationNumber, taxRegistrationAddress, taxRegistrationMessage.
-
Uses template:
- BillRemitPartyDetailT
Field components:
- An array.
-
Uses template:
TaxRegisterationDetailT.
- ChargeDetailT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, description, chargeAmount, taxDetails.
-
Uses template:
- VendorItemT
Field components:
-
Uses template:
ShortText. - Contains the following components: itemSequenceNumber, buyerProductIdentifier, amazonProductIdentifier, title, orderedQuantity, netPrice, vendorProductIdentifier, invoicedQuantity, netCost, purchaseOrderNumber, vendorOrderNumber, hsnCode, availableQuantity, isObsolete, itemSequenceNumber, isBackOrderAllowed, listPrice, taxDetails, chargeDetails.
-
Uses template:
- CatalogCategoryParentT
Field components:
-
Uses template:
ShortText. - Contains the following components: ProductCategoryId, ProductCategoryName.
-
Uses template:
- ResourceT
Field components:
-
Uses template:
ShortText. - Contains the following components: arn.
-
Uses template:
- VendorIdentifierT
Field components:
-
Uses template:
ShortText. - Contains the following components: containerIdentificationType, containerIdentificationNumber.
-
Uses template:
- ProductCategoryT
Field components:
-
Uses template:
ShortText. - Contains the following components: displayName, value.
-
Uses template:
- ValueAsWeightT
Field components:
-
Uses template:
ShortText. - Contains the following components: oz, g.
-
Uses template:
- AdditionalSellerInputT
Field components:
-
Uses template:
ShortText. - Contains the following components: DataType, ValueAsString, ValueAsBoolean, ValueAsInteger, ValueAsTimestamp, ValueAsAddress, ValueAsWeight, ValueAsDimension, ValueAsCurrency.
-
Uses template:
- OffssetT
Field components:
-
Uses template:
UnitsValuesT. - Contains the following components: x, y.
-
Uses template:
- SizeT
Field components:
-
Uses template:
UnitsValuesT. - Contains the following components: width, height.
-
Uses template:
- ImageT
Field components:
-
Uses template:
ShortText. - Contains the following components: uploadDestinationId, imageCropSpecification, altText.
-
Uses template:
- DecoratorSetT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, offset, length, depth.
-
Uses template:
- TextListT
Field components:
-
Uses template:
ShortText. - Contains the following components: value, decoratorSet.
-
Uses template:
- BodyT
Field components:
- Contains the following components: textList.
- BlockT
Field components:
-
Uses template:
ImageT. - Contains the following components: image, headline, body.
-
Uses template:
- TextBlockT
Field components:
-
Uses template:
TextListT. - Contains the following components: headline, body.
-
Uses template:
- ContentMetricT
Field components:
-
Uses template:
ShortText. - Contains the following components: position, value.
-
Uses template:
- GeneralTextListT
Field components:
- An array.
- Contains the following components: position, text.
- CatalogItemAT
Field components:
- An array.
-
Uses template:
CatalogItemAttributeT.
- GeneralCatalogAT
Field components:
- An array.
-
Uses template:
GeneralCatalogAttributeT.
- RejectionReasonT
Field components:
-
Uses template:
ShortText. - Contains the following components: RejectionReasonId, RejectionReasonDescription.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.