Notifications Resource
All of the Fulfillment Inbound endpoints are supported by this SDK.
Calling the method for the endpoint will return a data transfer object, from the Jasara\AmznSPA\DataTransferObjects\Responses\FulfillmentInbound
namespace. Read more about responses.
getInboundGuidance
Usage
$response = $spa->fulfillment_inbound->getInboundGuidance($marketplace_id); // GetInboundGuidanceResponse
Parameters
Parameter | Type | Examples | Description |
---|---|---|---|
marketplace_id
Required
| string | ATVPDKIKX0DER | A valid marketplace ID |
seller_sku_list
Optional
| array<string> | ['CR-ABC-4122'] | An array of Seller SKUs to filter by |
asin_list
Optional
| array<string> | ['B01A55GA98A'] | An array of ASINs to filter by |
Payload: fulfillment-inbound/GetInboundGuidanceResultSchema
Key | Type | Examples | Description |
---|---|---|---|
sku_inbound_guidance_list
| schema | SKUInboundGuidanceListSchema | A list of SKU inbound guidance information. |
SKUInboundGuidanceSchema.seller_sku
| string | CR-ABC-1234 | The seller SKU of the item. |
SKUInboundGuidanceSchema.asin
| string | B01A55GA98A | The Amazon Standard Identification Number (ASIN) of the item. |
SKUInboundGuidanceSchema.inbound_guidance
| string (enum) | InboundOK | Specific inbound guidance for an item. See valid values. |
SKUInboundGuidanceSchema.guidance_reason_list
| array<string> (enum) | ['SlowMovingASIN'] | A list of inbound guidance reason information. See valid values. |
invalid_sku_list
| schema | InvalidSKUListSchema | A list of invalid SKU values and the reason they are invalid. |
InvalidSKUSchema.seller_sku
| string | CR-ABC-1234 | The seller SKU of the item. |
InvalidSKUSchema.error_reason
| string (enum) | DoesNotExist | The reason why the seller SKU/ASIN is invalid. See valid values. |
asin_inbound_guidance_list
| schema | ASINInboundGuidanceListSchema | A list of ASINs and their associated inbound guidance. |
ASINInboundGuidanceSchema.asin
| string | B01A55GA98A | The Amazon Standard Identification Number (ASIN) of the item. |
ASINInboundGuidanceSchema.inbound_guidance
| string (enum) | InboundOK | Specific inbound guidance for an item. See valid values. |
ASINInboundGuidanceSchema.guidance_reason_list
| array<string> (enum) | ['SlowMovingASIN'] | A list of inbound guidance reason information. See valid values. |
invalid_asin_list
| schema | InvalidASINListSchema | A list of invalid ASIN values and the reason they are invalid. |
InvalidASINSchema.asin
| string | B01A55GA98A | The Amazon Standard Identification Number (ASIN) of the item. |
InvalidASINSchema.error_reason
| string (enum) | DoesNotExist | The reason why the seller SKU/ASIN is invalid. See valid values. |
createInboundShipmentPlan
Usage
$request = new CreateInboundShipmentPlanRequest(
...
);
$response = $spa->fulfillment_inbound->createInboundShipmentPlan($request); // CreateInboundShipmentPlanResponse
Parameters
Parameter | Type | Examples | Description |
---|---|---|---|
request
Required
| schema | CreateInboundShipmentPlanRequest | The object containing the data from the request |
CreateInboundShipmentPlanRequest.ship_from_address
Required
| schema | AddressSchema | The address from which the inbound shipment will be sent. |
AddressSchema.name
Required
| string (max: 50) | ACME Inc. | Name of the individual or business. |
AddressSchema.address_line_1
Required
| string (max: 180) | 123 Sample St | The street address information. |
AddressSchema.address_line_2
Optional
| string (max: 60) | Suite B | Additional street address information, if required. |
AddressSchema.district_or_county
Optional
| string (max: 25) | Wise County | The district or county. |
AddressSchema.city
Required
| string (max: 30) | New York | The city |
AddressSchema.state_or_province_code
Required
| string | NY | The state or province code. |
AddressSchema.country_code
Required
| string (max: 2) | US | The country code in two-character ISO 3166-1 alpha-2 format. |
AddressSchema.postal_code
Required
| string (max: 30) | 21221 | The postal code. |
CreateInboundShipmentPlanRequest.label_prep_preference
Required
| string (enum) | SELLER_LABEL | The seller's preference for label preparation for an inbound shipment. See valid values.. |
CreateInboundShipmentPlanRequest.ship_to_country_code
Optional
| string (max: 2) | US | The two-character country code for the country where the inbound shipment is to be sent. Default: The country code for the seller's home marketplace. |
CreateInboundShipmentPlanRequest.ship_to_country_subdivision_code
Optional
| string | IN-MH | The two-character country code, followed by a dash and then up to three characters that represent the subdivision of the country where the inbound shipment is to be sent. For example, "IN-MH". In full ISO 3166-2 format. |
CreateInboundShipmentPlanRequest.inbound_shipment_plan_request_items
Required
| schema | InboundShipmentPlanRequestItemListSchema | The list of inbound shipment items |
InboundShipmentPlanRequestItemSchema.seller_sku
Required
| string | CR-ABC-1234 | The seller SKU of the item. |
InboundShipmentPlanRequestItemSchema.asin
Required
| string | B01A55GA98A | The Amazon Standard Identification Number (ASIN) of the item. |
InboundShipmentPlanRequestItemSchema.condition
Required
| string (enum) | NewItem | The condition of the item. See valid values. |
InboundShipmentPlanRequestItemSchema.quantity
Required
| integer | 12 | The item quantity. |
InboundShipmentPlanRequestItemSchema.quantity_in_case
Optional
| integer | 4 | The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied by the number of cases in the inbound shipment equals Quantity. Also note that all of the boxes of an inbound shipment must either be case packed or individually packed. For that reason, when you submit the createInboundShipmentPlan operation, the value of QuantityInCase must be provided for every item in the shipment or for none of the items in the shipment. |
InboundShipmentPlanRequestItemSchema.prep_details_list
Optional
| schema | PrepDetailsListSchema | A list of preparation instructions and who is responsible for that preparation. |
PrepDetailsSchema.prep_instruction
Required
| string (enum) | Polybagging | Preparation instructions for shipping an item to Amazon's fulfillment network. See valid values.. |
PrepDetailsSchema.prep_owner
Required
| string (enum) | AMAZON | Indicates who will prepare the item. See valid values.. |
Payload: fulfillment-inbound/CreateInboundShipmentPlanResultSchema
Key | Type | Examples | Description |
---|---|---|---|
inbound_shipment_plans
| schema | InboundShipmentPlanListSchema | A list of inbound shipment plan information |
InboundShipmentPlanSchema.shipment_id
| string | FBA123ABC123 | A shipment identifier originally returned by the createInboundShipmentPlan operation. |
InboundShipmentPlanSchema.destination_fulfillment_center_id
| string | AVP1 | An Amazon fulfillment center identifier created by Amazon. |
InboundShipmentPlanSchema.ship_to_address
| schema | AddressSchema | The address of the Amazon fulfillment center to which to ship the items. |
AddressSchema.name
| string (max: 50) | ACME Inc. | Name of the individual or business. |
AddressSchema.address_line_1
| string (max: 180) | 123 Sample St | The street address information. |
AddressSchema.address_line_2
| string (max: 60) | Suite B | Additional street address information, if required. |
AddressSchema.district_or_county
| string (max: 25) | Wise County | The district or county. |
AddressSchema.city
| string (max: 30) | New York | The city |
AddressSchema.state_or_province_code
| string | NY | The state or province code. |
AddressSchema.country_code
| string (max: 2) | US | The country code in two-character ISO 3166-1 alpha-2 format. |
AddressSchema.postal_code
| string (max: 30) | 21221 | The postal code. |
InboundShipmentPlanSchema.label_prep_type
| string (enum) | SELLER_LABEL | The type of label preparation that is required for the inbound shipment. See valid values.. |
InboundShipmentPlanSchema.items
| schema | InboundShipmentPlanItemListSchema | SKU and quantity information for the items in the shipment. |
InboundShipmentPlanItemSchema.seller_sku
| string | CR-ABC-1234 | The seller SKU of the item. |
InboundShipmentPlanItemSchema.fulfillment_network_sku
| string | X00ABC123ABC | Amazon's fulfillment network SKU of the item. |
InboundShipmentPlanItemSchema.quantity
| integer | 12 | The item quantity. |
InboundShipmentPlanItemSchema.prep_details_list
| schema | PrepDetailsListSchema | A list of preparation instructions and who is responsible for that preparation. |
InboundShipmentPlanSchema.estimated_box_contents_fee
| schema | BoxContentsFeeDetailsSchema | The manual processing fee per unit and total fee for a shipment. |
BoxContentsFeeDetailsSchema.total_units
| integer | 12 | The number of units to ship. |
BoxContentsFeeDetailsSchema.fee_per_unit
| schema | AmountSchema | The manual processing fee per unit. |
AmountSchema.currency_code
| string | USD | The currency code. |
AmountSchema.value
| string (big decimal) | 100.00 | The amount. |
BoxContentsFeeDetailsSchema.total_fee
| schema | AmountSchema | The total manual processing fee for the shipment. |
AmountSchema.currency_code
| string | USD | The currency code. |
AmountSchema.value
| string (big decimal) | 100.00 | The amount. |