-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
61 changed files
with
14,578 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,305 @@ | ||
| /** | ||
| * Fulfillment API requests and definitions for Amazon's MWS web services. | ||
| * Currently untested, for the most part because I don't have an account | ||
| * with Fulfillment By Amazon services. | ||
| * | ||
| * @author Robert Saunders | ||
| */ | ||
| var mws = require('./mws'); | ||
|
|
||
| /** | ||
| * Construct a mws fulfillment api request for mws.Client.invoke() | ||
| * @param {String} group Group name (category) of request | ||
| * @param {String} path Path of associated group | ||
| * @param {String} action Action request will be calling | ||
| * @param {Object} params Schema of possible request parameters | ||
| */ | ||
| function FulfillmentRequest(group, path, action, params) { | ||
| var opts = { | ||
| name: 'Fulfillment', | ||
| group: group, | ||
| path: path, | ||
| version: '2010-10-01', | ||
| legacy: false, | ||
| action: action, | ||
| params: params | ||
| }; | ||
| return new mws.Request(opts); | ||
| } | ||
|
|
||
| function FbaInboundRequest(action, params) { | ||
| return FulfillmentRequest('Inbound Shipments', '/FulfillmentInboundShipment/2010-10-01', action, params); | ||
| } | ||
|
|
||
| function FbaInventoryRequest(action, params) { | ||
| return FulfillmentRequest('Inventory', '/FulfillmentInventory/2010-10-01', action, params); | ||
| } | ||
|
|
||
| function FbaOutboundRequest(action, params) { | ||
| return FulfillmentRequest('Outbound Shipments', '/FulfillmentOutboundShipment/2010-10-01', action, params); | ||
| } | ||
|
|
||
| /** | ||
| * Ojects to represent enum collections used by some request(s) | ||
| * @type {Object} | ||
| */ | ||
| var enums = exports.enums = { | ||
|
|
||
| ResponseGroups: function() { | ||
| return new mws.Enum(['Basic', 'Detailed']); | ||
| }, | ||
|
|
||
| ShippingSpeedCategories: function() { | ||
| return new mws.Enum(['Standard', 'Expedited', 'Priority']); | ||
| }, | ||
|
|
||
| FulfillmentPolicies: function() { | ||
| return new mws.Enum(['FillOrKill', 'FillAll', 'FillAllAvailable']); | ||
| } | ||
|
|
||
| }; | ||
|
|
||
| /** | ||
| * A collection of currently supported request constructors. Once created and | ||
| * configured, the returned requests can be passed to an mws client `invoke` call | ||
| * @type {Object} | ||
| */ | ||
| var calls = exports.requests = { | ||
|
|
||
| // Inbound Shipments | ||
| inbound: { | ||
|
|
||
| GetServiceStatus: function() { | ||
| return new FbaInboundRequest('GetServiceStatus', {}); | ||
| }, | ||
|
|
||
| CreateInboundShipment: function() { | ||
| return new FbaInboundRequest('CreateInboundShipment', { | ||
| ShipmentId: { name: 'ShipmentId', required: true}, | ||
| Shipmentname: { name: 'InboundShipmentHeader.ShipmentName', required: true }, | ||
| ShipFromname: { name: 'InboundShipmentHeader.ShipFromAddress.Name', required: true }, | ||
| ShipFromAddressLine1: { name: 'InboundShipmentHeader.ShipFromAddress.AddressLine1', required: true }, | ||
| ShipFromAddressLine2: { name: 'InboundShipmentHeader.ShipFromAddress.AddressLine2', required: false }, | ||
| ShipFromAddressCity: { name: 'InboundShipmentHeader.ShipFromAddress.City', required: true }, | ||
| ShipFromDistrictOrCounty: { name: 'InboundShipmentHeader.ShipFromAddress.DistrictOrCounty', required: false }, | ||
| ShipFromStateOrProvince: { name: 'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode', required: true }, | ||
| ShipFromPostalCode: { name: 'InboundShipmentHeader.ShipFromAddress.PostalCode', required: true }, | ||
| ShipFromCountryCode: { name: 'InboundShipmentHeader.ShipFromAddress.CountryCode', required: true }, | ||
| DestinationFulfillmentCenterId: { name: 'InboundShipmentHeader.DestinationFulfillmentCenterId', required: true }, | ||
| ShipmentStatus: { name: 'InboundShipmentHeader.ShipmentStatus' }, | ||
| LabelPrepPreference: { name: 'InboundShipmentHeader.LabelPrepPreference' }, | ||
| InboundShipmentItems: { name: 'InboundShipmentItems', type: 'Complex', list: true, required: true, sub: [ | ||
| { name: 'InboundShipmentItems.member.-.QuantityShipped' }, | ||
| { name: 'InboundShipmentItems.member.-.SellerSKU' } | ||
| ]} | ||
| }); | ||
| }, | ||
|
|
||
| CreateInboundShipmentPlan: function() { | ||
| return new FbaInboundRequest('CreateInboundShipmentPlan', { | ||
| LabelPrepPreference: { name: 'LabelPrepPreference', required: true }, | ||
| { name: 'ShipFromAddress.Name' }, | ||
| { name: 'ShipFromAddress.AddressLine1' }, | ||
| { name: 'ShipFromAddress.City' }, | ||
| { name: 'ShipFromAddress.StateOrProvinceCode' }, | ||
| { name: 'ShipFromAddress.PostalCode' }, | ||
| { name: 'ShipFromAddress.CountryCode' }, | ||
| { name: 'ShipFromAddress.AddressLine2' }, | ||
| { name: 'ShipFromAddress.DistrictOrCounty' } | ||
| { name: 'InboundShipmentPlanRequestItems', required: true, list: true, type: 'Complex', | ||
| { name: 'InboundShipmentPlanRequestItems.member.-.SellerSKU' }, | ||
| { name: 'InboundShipmentPlanRequestItems.member.-.ASIN' }, | ||
| { name: 'InboundShipmentPlanRequestItems.member.-.Quantity' }, | ||
| { name: 'InboundShipmentPlanRequestItems.member.-.Condition' } | ||
| }, | ||
| }); | ||
| }, | ||
|
|
||
| ListInboundShipmentItems: function() { | ||
| return new FbaInboundRequest('ListInboundShipmentItems', { | ||
| { name: 'ShipmentId', required: true }, | ||
| { name: 'LastUpdatedAfter', type: 'Timestamp' }, | ||
| { name: 'LastUpdatedBefore', type: 'Timestamp' } | ||
| }); | ||
| }, | ||
|
|
||
| ListInboundShipmentItemsByNextToken: function() { | ||
| return new FbaInboundRequest('ListInboundShipmentItemsByNextToken', { | ||
| NextToken: { name: 'NextToken', required: true } | ||
| }); | ||
| }, | ||
|
|
||
| ListInboundShipments: function() { | ||
| return new FbaInboundRequest('ListInboundShipments', { | ||
| ShipmentStatuses: { name: 'ShipmentStatusList.member', list: true, required: false }, | ||
| ShipmentIds: { name: 'ShipmentIdList.member', list: true, required: false }, | ||
| LastUpdatedAfter: { name: 'LastUpdatedAfter', type: 'Timestamp' }, | ||
| LastUpdatedBefore: { name: 'LastUpdatedBefore', type: 'Timestamp' } | ||
| }); | ||
| }, | ||
|
|
||
| ListInboundShipmentsByNextToken: function() { | ||
| return new FbaInboundRequest('ListInboundShipmentsByNextToken', { | ||
| NextToken: { name: 'NextToken', required: true } | ||
| }); | ||
| }, | ||
|
|
||
| UpdateInboundShipment: function() { | ||
| return new FbaInboundRequest('UpdateInboundShipment', { | ||
| { name: 'ShipmentId', required: true }, | ||
| { name: 'Inbound Shipment Header', type: 'Complex', required: true, | ||
|
|
||
| { name: 'InboundShipmentHeader.ShipmentName', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.Name', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.AddressLine1', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.AddressLine2', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.City', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.PostalCode', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.CountryCode', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipFromAddress.DistrictOrCounty', required: true }, | ||
| { name: 'InboundShipmentHeader.DestinationFulfillmentCenterId', required: true }, | ||
| { name: 'InboundShipmentHeader.ShipmentStatus' }, | ||
| { name: 'InboundShipmentHeader.LabelPrepPreference' } | ||
| ] | ||
| }, | ||
| { name: 'InboundShipmentItems', type: 'Complex', list: true, required: true, | ||
|
|
||
| { name: 'InboundShipmentItems.member.-.QuantityShipped' }, | ||
| { name: 'InboundShipmentItems.member.-.SellerSKU' } | ||
| ] | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| }, | ||
|
|
||
| // Inventory | ||
| inventory: { | ||
|
|
||
| GetServiceStatus: function() { | ||
| return new FbaInventoryRequest('GetServiceStatus', {}); | ||
| }, | ||
|
|
||
| ListInventorySupply: function() { | ||
| return new FbaInventoryRequest('ListInventorySupply', { | ||
| SellerSkus: { name: 'SellerSkus.member', list: true }, | ||
| QueryStartDateTime: { name: 'QueryStartDateTime', type: 'Timestamp' }, | ||
| ResponseGroup: { name: 'ResponseGroup' } | ||
| }); | ||
| }, | ||
|
|
||
| ListInventorySupplyByNextToken: function() { | ||
| return new FbaInventoryRequest('ListInventorySupplyByNextToken', { | ||
| NextToken: { name: 'NextToken', required: true } | ||
| }); | ||
| } | ||
|
|
||
| }, | ||
|
|
||
| // Outbound Shipments | ||
| outbound: { | ||
|
|
||
| GetServiceStatus: function() { | ||
| return new FbaOutboundRequest('GetServiceStatus', {}); | ||
| }, | ||
|
|
||
| CancelFulfillmentOrder: function() { | ||
| return new FbaOutboundRequest('CancelFulfillmentOrder', { | ||
| SellerFulfillmentOrderId: { name: 'SellerFulfillmentOrderId', required: true } | ||
| }); | ||
| }, | ||
|
|
||
| CreateFulfillmentOrder: function() { | ||
| return new FbaOutboundRequest('CreateFulfillmentOrder', { | ||
| { name: 'SellerFulfillmentOrderId', required: true }, | ||
| { name: 'ShippingSpeedCategory', required: true, type: 'fba.ShippingSpeedCategory' }, | ||
| { name: 'DisplayableOrder', type: 'Complex', required: true, | ||
| Parameters: [ | ||
| { name: 'DisplayableOrderId', required: true }, | ||
| { name: 'DisplayableOrderDateTime', type: 'Timestamp' }, | ||
| { name: 'DisplayableOrderComment' } | ||
| ] | ||
| }, | ||
| { name: 'FulfillmentPolicy', required: false, type: 'fba.FulfillmentPolicy' }, | ||
| { name: 'FulfillmentMethod', required: false }, | ||
| { name: 'NotificationEmailList.member', required: false, list: true }, | ||
| { name: 'DestinationAddress', required: true, type: 'Complex', | ||
| Parameters: [ | ||
| { name: 'DestinationAddress.Name' }, | ||
| { name: 'DestinationAddress.Line1' }, | ||
| { name: 'DestinationAddress.Line2' }, | ||
| { name: 'DestinationAddress.Line3' }, | ||
| { name: 'DestinationAddress.City' }, | ||
| { name: 'DestinationAddress.StateOrProvinceCode', Displayname: "State/Province" }, | ||
| { name: 'DestinationAddress.PostalCode' }, | ||
| { name: 'DestinationAddress.CountryCode' }, | ||
| { name: 'DestinationAddress.DistrictOrCounty' }, | ||
| { name: 'DestinationAddress.PhoneNumber' } | ||
| ] | ||
| }, | ||
| { name: 'LineItems', type: 'Complex', required: true, list: true, | ||
| Parameters: [ | ||
| { name: 'Items.member.-.DisplayableComment' }, | ||
| { name: 'Items.member.-.GiftMessage' }, | ||
| { name: 'Items.member.-.PerUnitDeclaredValue.Value' }, | ||
| { name: 'Items.member.-.PerUnitDeclaredValue.CurrencyCode' }, | ||
| { name: 'Items.member.-.Quantity' }, | ||
| { name: 'Items.member.-.SellerFulfillmentOrderItemId' }, | ||
| { name: 'Items.member.-.SellerSKU' } | ||
| ] | ||
| } | ||
| }); | ||
| }, | ||
|
|
||
| GetFulfillmentOrder: function() { | ||
| return new FbaOutboundRequest('GetFulfillmentOrder', { | ||
| SellerFulfillmentOrderId: { name: 'SellerFulfillmentOrderId', required: true } | ||
| }); | ||
| }, | ||
|
|
||
| GetFulfillmentPreview: function() { | ||
| return new FbaOutboundRequest('GetFulfillmentPreview', { | ||
| { name: 'Address', required: true, type: 'Complex', | ||
| Parameters: [ | ||
| { name: 'Address.Name' }, | ||
| { name: 'Address.Line1' }, | ||
| { name: 'Address.Line2' }, | ||
| { name: 'Address.Line3' }, | ||
| { name: 'Address.City' }, | ||
| { name: 'Address.StateOrProvinceCode' }, | ||
| { name: 'Address.PostalCode' }, | ||
| { name: 'Address.CountryCode' }, | ||
| { name: 'Address.DistrictOrCounty' }, | ||
| { name: 'Address.PhoneNumber' } | ||
| ] | ||
| }, | ||
| { name: 'LineItems', type: 'Complex', required: true, list: true, | ||
| Parameters: [ | ||
| { name: 'Items.member.-.Quantity' }, | ||
| { name: 'Items.member.-.SellerFulfillmentOrderItemId' }, | ||
| { name: 'Items.member.-.SellerSKU' }, | ||
| { name: 'Items.member.-.EstimatedShippingWeight' }, | ||
| { name: 'Items.member.-.ShippingWeightCalculationMethod' } | ||
| ] | ||
| }, | ||
| { name: 'ShippingSpeedCategories.member', list: true, type: 'fba.ShippingSpeedCategory' } | ||
| }); | ||
| }, | ||
|
|
||
| ListAllFulfillmentOrders: function() { | ||
| return new FbaOutboundRequest('ListAllFulfillmentOrders', { | ||
| QueryStartDateTime: { name: 'QueryStartDateTime', required: true, type: 'Timestamp' }, | ||
| FulfillentMethods: { name: 'FulfillmentMethod.member', list: true } | ||
| }); | ||
| }, | ||
|
|
||
| ListAllFulfillmentOrdersByNextToken: function() { | ||
| return new FbaOutboundRequest('ListAllFulfillmentOrdersByNextToken', { | ||
| NextToken: { name: 'NextToken', required: true } | ||
| }); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| }; |
Oops, something went wrong.