fba-inbound-docs.silkhub.co
Open in
urlscan Pro
2600:9000:21da:e800:7:6c03:3f00:93a1
Public Scan
URL:
https://fba-inbound-docs.silkhub.co/
Submission: On January 15 via api from US — Scanned from US
Submission: On January 15 via api from US — Scanned from US
Form analysis
0 forms found in the DOMText Content
Select the API specification to view Plugin Integration * Core * Inbound Rules * getGet inbound shipment automation rules * postCreate an inbound shipment automation rule * getGet an inbound shipment automation rule * patchUpdate an inbound shipment automation rule * delDelete an inbound shipment automation rule * getGet shipments of an inbound rule * getGet inbound shipment proposals * getGet an inbound shipment proposal * delDismiss an inbound shipment proposal * Inbound Shipments * getGet inbound shipments * postCreate one or more inbound shipments * getGet an inbound shipment * postConfirm an inbound shipment * postCancel an inbound shipment * postGet recommended inbound quantities for products * Inbound Metrics * getGet metrics of inbound shipments * Events * Integration Events * postPost integration event notifications * External Events * postPost an Amazon Selling Partner (SP) notification API docs by Redocly FBA INBOUND SHIPMENTS PLUGIN API (0.5.0) Download OpenAPI specification:Download Operations provisioned by the plugin that expose its functionality to the main system. INBOUND RULES Operations related to inbound rules. An inbound rule is an automation rule for set of products. When a rule is executed, the FBA sales velocity and stock levels of its products are considered to determine whether an inbound shipment is in need, in order to prevent stock-outs. If an inbound shipment is required, the optimal inbound quantities of products are determined based on their pre-FBA and FBA storage fee rates, outbound costs and potential cost-savings enabled by consolidated shipping. GET INBOUND SHIPMENT AUTOMATION RULES Returns a list of inbound shipment automation rules. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. QUERY PARAMETERS active boolean Filter results by activation status. name string Filter results by name. sku string (ProductSku) Example: sku=my-example-sku Filter results by included SKU.name: sku warehouseId string (WarehouseId) Filter results by source warehouse ID. limit integer (Limit) The maximum number of items to return per page. offset integer (Offset) The number of items to skip before starting to collect the result set. sortField string Enum: "active" "createdAt" "mode" "name" "updatedAt" "warehouseId" Sort results by field. sortOrder string Enum: "ASC" "DESC" Sort results in a specific order. RESPONSES 200 A list of inbound shipment automation rules. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-rules https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-rules RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all { * "data": [ * { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string" } ], * "pagination": { * "totalCount": 0 } } CREATE AN INBOUND SHIPMENT AUTOMATION RULE Creates an inbound shipment automation rule. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. REQUEST BODY SCHEMA: APPLICATION/JSON REQUIRED executeNow required boolean (InboundRuleExecuteNow) Default: false Indicates whether the rule should be executed immediately after creation or update. inboundRule required object (InboundRuleCreateParams) RESPONSES 201 The newly created inbound shipment automation rule. 409 An inbound shipment automation rule with at least one of the specified products already exists. default An unexpected condition occurred that prevented the server from fulfilling the request. post/sellers/{sellerId}/inbound-rules https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-rules REQUEST SAMPLES * Payload Content type application/json Copy Expand all Collapse all { * "executeNow": false, * "inboundRule": { * "active": true, * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "minStockLevelPreFba": 0, * "minStockLevelFba": 0, * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "mode": "PROPOSAL_ONLY", * "name": "string", * "warehouseId": "string" } } RESPONSE SAMPLES * 201 * 409 * default Content type application/json Copy Expand all Collapse all { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string", * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "minStockLevelPreFba": 0, * "minStockLevelFba": 0, * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "itemsTotal": 0 } GET AN INBOUND SHIPMENT AUTOMATION RULE Returns detailed information about an inbound shipment automation rule. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundRuleId required string (InboundRuleId) The unique identifier of an inbound shipment automation rule. RESPONSES 200 The inbound shipment automation rule corresponding to the provided inboundRuleId. 404 No inbound shipment automation rule found for the provided inboundRuleId. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-rules/{inboundRuleId} https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-rules/{inboundRuleId} RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string", * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "minStockLevelPreFba": 0, * "minStockLevelFba": 0, * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "itemsTotal": 0 } UPDATE AN INBOUND SHIPMENT AUTOMATION RULE Updates an inbound shipment automation rule. Performing this operation doe snot affect inbound shipments that have been created by the ruleearlier. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundRuleId required string (InboundRuleId) The unique identifier of an inbound shipment automation rule. REQUEST BODY SCHEMA: APPLICATION/JSON REQUIRED executeNow required boolean (InboundRuleExecuteNow) Default: false Indicates whether the rule should be executed immediately after creation or update. inboundRule required object (InboundRuleUpdateParams) RESPONSES 200 The updated inbound shipment automation rule. 404 No inbound shipment automation rule found for the provided inboundRuleId. default An unexpected condition occurred that prevented the server from fulfilling the request. patch/sellers/{sellerId}/inbound-rules/{inboundRuleId} https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-rules/{inboundRuleId} REQUEST SAMPLES * Payload Content type application/json Copy Expand all Collapse all { * "executeNow": false, * "inboundRule": { * "active": true, * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "minStockLevelPreFba": 0, * "minStockLevelFba": 0, * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "mode": "PROPOSAL_ONLY", * "name": "string", * "warehouseId": "string" } } RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string", * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "minStockLevelPreFba": 0, * "minStockLevelFba": 0, * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "itemsTotal": 0 } DELETE AN INBOUND SHIPMENT AUTOMATION RULE Deletes an inbound shipment automation rule. Any inbound shipments that were created by the rule will be preserved. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundRuleId required string (InboundRuleId) The unique identifier of an inbound shipment automation rule. RESPONSES 200 The deleted inbound shipment automation rule. 404 No inbound shipment automation rule found for the provided inboundRuleId. default An unexpected condition occurred that prevented the server from fulfilling the request. delete/sellers/{sellerId}/inbound-rules/{inboundRuleId} https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-rules/{inboundRuleId} RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string", * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "minStockLevelPreFba": 0, * "minStockLevelFba": 0, * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "itemsTotal": 0 } GET SHIPMENTS OF AN INBOUND RULE Returns a list of inbound shipments that have been created automatically based on the specified inbound rule. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundRuleId required string (InboundRuleId) The unique identifier of an inbound shipment automation rule. QUERY PARAMETERS sku string (ProductSku) Example: sku=my-example-sku Filter results by included SKU.name: sku status string (InboundShipmentStatus) Enum: "PLANNED" "CREATING_INBOUND" "ESTIMATING_TRANSPORT" "WAITING_FOR_CONFIRMATION" "CONFIRMING" "PRINTING_LABELS" "CREATING_OUTBOUND" "WORKING" "SHIPPED" "CLOSED" "CANCELLING" "CANCELLED" "FAILED" Filter results by shipment status. limit integer (Limit) The maximum number of items to return per page. offset integer (Offset) The number of items to skip before starting to collect the result set. sortField string Enum: "amazonMarketplaceId" "createdAt" "name" "status" "updatedAt" "warehouseId" Sort results by field. sortOrder string Enum: "ASC" "DESC" Sort results in a specific order. RESPONSES 200 A list of inbound shipments. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-rules/{inboundRuleId}/shipments https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-rules/{inboundRuleId}/shipments RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all { * "data": [ * { * "amazonMarketplaceId": "A1PA6795UKMFR9", * "cancelReason": "CONFIRMATION_EXPIRED", * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "inboundRuleId": "string", * "name": "string", * "status": "PLANNED", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string" } ], * "pagination": { * "totalCount": 0 } } GET INBOUND SHIPMENT PROPOSALS Returns a list of inbound shipment proposals. Proposals are created and updated regularly based on inbound rules with a mode value of PROPOSE_SHIPMENT. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. QUERY PARAMETERS limit integer (Limit) The maximum number of items to return per page. offset integer (Offset) The number of items to skip before starting to collect the result set. sortField string Value: "updatedAt" Sort results by field. sortOrder string Enum: "ASC" "DESC" Sort results in a specific order. RESPONSES 200 A list of inbound shipment proposals. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-shipment-proposals https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipment-proposals RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all { * "data": [ * { * "inboundRule": { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string" }, * "itemsTotal": 0, * "unitsTotal": 0, * "updatedAt": "2019-08-24T14:15:22Z" } ], * "pagination": { * "totalCount": 0 } } GET AN INBOUND SHIPMENT PROPOSAL Returns detailed information about an inbound shipment proposal. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundRuleId required string (InboundRuleId) The unique identifier of an inbound shipment automation rule. RESPONSES 200 The inbound shipment proposal. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-shipment-proposals/{inboundRuleId} https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipment-proposals/{inboundRuleId} RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all { * "inboundRule": { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string" }, * "itemsTotal": 0, * "unitsTotal": 0, * "updatedAt": "2019-08-24T14:15:22Z", * "items": [ * { * "sku": "my-example-sku", * "quantity": 1 } ] } DISMISS AN INBOUND SHIPMENT PROPOSAL Dismisses the inbound shipment proposal of a role. This should be called whenever a shipment has been created based on the proposal. If the inbound rule that created the proposal is still active, a new proposal will automatically be created if needed when the rule is next evaluated. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundRuleId required string (InboundRuleId) The unique identifier of an inbound shipment automation rule. RESPONSES 200 The inbound shipment proposal was successfully deleted. default An unexpected condition occurred that prevented the server from fulfilling the request. delete/sellers/{sellerId}/inbound-shipment-proposals/{inboundRuleId} https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipment-proposals/{inboundRuleId} RESPONSE SAMPLES * default Content type application/json Copy { * "message": "string" } INBOUND SHIPMENTS Operations related to inbound shipments. GET INBOUND SHIPMENTS Returns a list of inbound shipments. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. QUERY PARAMETERS name string Filter results by name. sku string (ProductSku) Example: sku=my-example-sku Filter results by included SKU.name: sku warehouseId string (WarehouseId) Filter results by source warehouse ID. status string (InboundShipmentStatus) Enum: "PLANNED" "CREATING_INBOUND" "ESTIMATING_TRANSPORT" "WAITING_FOR_CONFIRMATION" "CONFIRMING" "PRINTING_LABELS" "CREATING_OUTBOUND" "WORKING" "SHIPPED" "CLOSED" "CANCELLING" "CANCELLED" "FAILED" Filter results by shipment status. limit integer (Limit) The maximum number of items to return per page. offset integer (Offset) The number of items to skip before starting to collect the result set. sortField string Enum: "amazonMarketplaceId" "createdAt" "name" "status" "updatedAt" "warehouseId" Sort results by field. sortOrder string Enum: "ASC" "DESC" Sort results in a specific order. RESPONSES 200 A list of inbound shipments. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-shipments https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipments RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all { * "data": [ * { * "amazonMarketplaceId": "A1PA6795UKMFR9", * "cancelReason": "CONFIRMATION_EXPIRED", * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "inboundRuleId": "string", * "name": "string", * "status": "PLANNED", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string" } ], * "pagination": { * "totalCount": 0 } } CREATE ONE OR MORE INBOUND SHIPMENTS Creates one or more inbound shipments. Shipment planning is performed by Amazon and multiple inbound shipments might be required so that items can be optimally placed in Amazon's fulfillment network — for example, positioning inventory closer to the customer. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. REQUEST BODY SCHEMA: APPLICATION/JSON REQUIRED inboundShipment required object (InboundShipmentCreateParams) requireConfirmation required boolean If true, a confirmation step will be required to approve the transport costs of the shipment once they are estimated. RESPONSES 201 Identifiers of the newly created inbound shipments. 400 Bad request. 500 Internal server error. default An unexpected condition occurred that prevented the server from fulfilling the request. post/sellers/{sellerId}/inbound-shipments https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipments REQUEST SAMPLES * Payload Content type application/json Copy Expand all Collapse all { * "inboundShipment": { * "amazonMarketplaceId": "A1PA6795UKMFR9", * "fbaLabelPrepPreference": "SELLER_LABEL", * "fbaPartneredCarrier": "UNITED_PARCEL_SERVICE_INC", * "items": [ * { * "sku": "my-example-sku", * "quantity": 1 } ], * "name": "string", * "warehouseId": "string" }, * "requireConfirmation": true } RESPONSE SAMPLES * 201 * 400 * 500 * default Content type application/json Copy Expand all Collapse all { * "inboundShipmentIds": [ * "string" ] } GET AN INBOUND SHIPMENT Returns detailed information about an inbound shipment. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundShipmentId required string (InboundShipmentId) The unique identifier of an inbound shipment. RESPONSES 200 The inbound shipment corresponding to the provided inboundShipmentId. 404 No inbound shipment found for the provided inboundShipmentId. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-shipments/{inboundShipmentId} https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipments/{inboundShipmentId} RESPONSE SAMPLES * 200 * 404 * default Content type application/json Copy Expand all Collapse all { * "amazonMarketplaceId": "A1PA6795UKMFR9", * "cancelReason": "CONFIRMATION_EXPIRED", * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "inboundRuleId": "string", * "name": "string", * "status": "PLANNED", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string", * "errors": [ * { * "message": "string", * "code": "CANCEL_INBOUND_FAILED", * "metadata": { * "sku": "my-example-sku" } } ], * "fbaLabelPrepType": "NO_LABEL", * "inboundRule": { * "active": true, * "createdAt": "2019-08-24T14:15:22Z", * "id": "string", * "lastExecutedAt": "2019-08-24T14:15:22Z", * "mode": "PROPOSAL_ONLY", * "name": "string", * "updatedAt": "2019-08-24T14:15:22Z", * "warehouseId": "string" }, * "items": [ * { * "amazonSellerSku": "string", * "amazonAsin": "string", * "jtlJfsku": "string", * "jtlMerchantSku": "string", * "quantityShipped": 0, * "quantityReceived": 0, * "sku": "my-example-sku" } ], * "itemsTotal": 0, * "shipFromAddress": { * "addressLine1": "string", * "addressLine2": "string", * "city": "string", * "countryCode": "string", * "districtOrCounty": "string", * "name": "string", * "postalCode": "string", * "stateOrProvinceCode": "string" }, * "shipToAddress": { * "addressLine1": "string", * "addressLine2": "string", * "city": "string", * "countryCode": "string", * "districtOrCounty": "string", * "name": "string", * "postalCode": "string", * "stateOrProvinceCode": "string" }, * "transport": { * "costs": { * "amount": 2143, * "currency": "EUR" }, * "confirmDeadline": "2019-08-24T14:15:22Z", * "labelsUrl": "string", * "voidDeadline": "2019-08-24T14:15:22Z" }, * "unitsReceived": 0, * "unitsTotal": 0 } CONFIRM AN INBOUND SHIPMENT Confirms the FBA-partnered transport costs of an inbound shipment. After the void deadline has passed, the seller's FBA account will be charged for the shipping cost. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundShipmentId required string (InboundShipmentId) The unique identifier of an inbound shipment. RESPONSES 202 The confirmation has been received. 404 No inbound shipment found for the provided inboundShipmentId. default An unexpected condition occurred that prevented the server from fulfilling the request. post/sellers/{sellerId}/inbound-shipments/{inboundShipmentId}/confirm https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipments/{inboundShipmentId}/confirm RESPONSE SAMPLES * 404 * default Content type application/json Copy { * "message": "string" } CANCEL AN INBOUND SHIPMENT Attempts to cancel an inbound shipment at Amazon FBA (inbound) and the source warehouse (outbound). Transport Costs * If the shipment had already been confirmed and the void deadline has not yet passed, the shipment's transport will be voided and the seller's FBA account will not be charged for the shipping cost. * If the shipment had already been confirmed and the void deadline has passed, the seller's FBA account will be charged for the shipping cost. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. inboundShipmentId required string (InboundShipmentId) The unique identifier of an inbound shipment. RESPONSES 202 The cancellation has been received. 404 No inbound shipment found for the provided `inboundShipmentId. default An unexpected condition occurred that prevented the server from fulfilling the request. post/sellers/{sellerId}/inbound-shipments/{inboundShipmentId}/cancel https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-shipments/{inboundShipmentId}/cancel RESPONSE SAMPLES * 404 * default Content type application/json Copy { * "message": "string" } GET RECOMMENDED INBOUND QUANTITIES FOR PRODUCTS Returns the recommended inbound quantities for products based on the seller's sales metrics and storage fees. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. REQUEST BODY SCHEMA: APPLICATION/JSON REQUIRED amazonMarketplaceId required string (AmazonMarketplaceId) An Amazon marketplace identifier. items required Array of objects (InboundQuantitiesRequestItem) The items to estimate inbound quantities for. warehouseId required string (WarehouseId) The unique identifier of a warehouse. Warehouse identifiers are externally managed by the main system. RESPONSES 200 A list of suggested inbound quantities. default An unexpected condition occurred that prevented the server from fulfilling the request. post/sellers/{sellerId}/inbound-quantities https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-quantities REQUEST SAMPLES * Payload Content type application/json Copy Expand all Collapse all { * "amazonMarketplaceId": "A1PA6795UKMFR9", * "items": [ * { * "sku": "my-example-sku", * "targetDaysOnStockFba": 0 } ], * "warehouseId": "string" } RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all [ * { * "sku": "my-example-sku", * "quantity": 1 } ] INBOUND METRICS GET METRICS OF INBOUND SHIPMENTS Returns general metrics of inbound shipments. AUTHORIZATIONS: sigv4Reference PATH PARAMETERS sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. RESPONSES 200 The inbound metrics for the seller. If no metrics have been calculated for the seller yet, the inboundMetrics property will be null. default An unexpected condition occurred that prevented the server from fulfilling the request. get/sellers/{sellerId}/inbound-metrics https://fba-inbound-docs.silkhub.co/sellers/{sellerId}/inbound-metrics RESPONSE SAMPLES * 200 * default Content type application/json Copy Expand all Collapse all { * "inboundMetrics": { * "avgInboundLead30Days": 3.7, * "avgInboundLead90Days": 3.7, * "avgInboundLead180Days": 3.7, * "avgInboundLead365Days": 3.7, * "updatedAt": "2019-08-24T14:15:22Z" } } INTEGRATION EVENTS Operations related to integration events that affect the plugin. POST INTEGRATION EVENT NOTIFICATIONS Delivers a list of integration event notifications to the plugin. AUTHORIZATIONS: sigv4Reference REQUEST BODY SCHEMA: APPLICATION/JSON REQUIRED A list of integration events. Array One of IntegrationEventProductDeletedIntegrationEventSellerDeletedIntegrationEventWarehouseDeleted eventType required string Enum: "PRODUCT_DELETED" "PRODUCTS_DELETED" "SELLER_DELETED" "WAREHOUSE_DELETED" The type of an integration event. * PRODUCTS_DELETED: An event indicating that products have been deleted from a seller's account in the main system. * SELLER_DELETED: An event indicating that a seller has been deleted from the main system. * WAREHOUSE_DELETED: An event indicating that a warehouse has been deleted from a seller's account in the main system. sellerId required string (SellerId) The unique Amazon FBA/SP API identifier of the seller. sku string (ProductSku) The unique (per seller) stock keeping unit of a product. Product skus are externally managed by the main system. action required string Enum: "REMOVE_FROM_RULE" "DELETE_RULE" The action to perform in response to the deletion of the product. * REMOVE_FROM_RULE - Retain the rule that references the deleted product (if any), but remove the product from the rule. If a rule contains only the deleted product, the rule itself is deleted. * DELETE_RULE - Delete the rule that references the deleted product (if any). RESPONSES 204 The event notifications have been received. default An unexpected condition occurred that prevented the server from fulfilling the request. post/integration-events https://fba-inbound-docs.silkhub.co/integration-events REQUEST SAMPLES * Payload Content type application/json Copy Expand all Collapse all [ * { * "eventType": "PRODUCT_DELETED", * "sellerId": "string", * "sku": "my-example-sku", * "action": "REMOVE_FROM_RULE" } ] RESPONSE SAMPLES * default Content type application/json Copy { * "message": "string" } EXTERNAL EVENTS Operations related to external events that affect the plugin. POST AN AMAZON SELLING PARTNER (SP) NOTIFICATION Delivers an Amazon Selling Partner (SP) Notifications API notification. The plugin expects to receive notifications of the following types: * FEED_PROCESSING_FINISHED - Specifically, all notifications with a feedType value of POST_FBA_INBOUND_CARTON_CONTENTS. Required for the creation of inbound shipments. * REPORT_PROCESSING_FINISHED - Specifically, all notifications with a reportType value of GET_FBA_STORAGE_FEE_CHARGES_DATA. Required for the calculation of FBA storage fees when optimizing inbound quantities for inbound rules. The plugin performs actions on its own that trigger the above notifications. To receive them, a notification subscription for each notification type must be configured. As the FBA/SP API seller identifier is contained within each notification, it is not an explicit parameter of this endpoint. AUTHORIZATIONS: sigv4Reference REQUEST BODY SCHEMA: APPLICATION/JSON REQUIRED The raw Amazon Selling Partner (SP) API notification. object RESPONSES 204 The Amazon Selling Partner (SP) API notification has been received. default An unexpected condition occurred that prevented the server from fulfilling the request. post/sp-api-notifications https://fba-inbound-docs.silkhub.co/sp-api-notifications REQUEST SAMPLES * Payload Content type application/json Copy { } RESPONSE SAMPLES * default Content type application/json Copy { * "message": "string" }