Home

Table of Contents

• MARKETPLACE
  • Properties
• REPORT_TYPE
  • Properties
• GRANULARITY
  • Properties
• SHIPMENT_STATUS
  • Properties
• GetReports
  • Parameters
• GetReport
  • Parameters
• CreateReport
  • Parameters
• GetDocument
  • Parameters
• GetOrderMetrics
  • Parameters
• GetShipments
  • Parameters
• GetNewClosedShipments
• GetShipmentItemsForShipment
  • Parameters
• GetClosedInboundShipments

MARKETPLACE

Type: object

Properties

• DE string A1PA6795UKMFR9
• US string ATVPDKIKX0DER

REPORT_TYPE

Type: object

Properties

• INVENTORY_RECEIVED string GET_FBA_FULFILLMENT_INVENTORY_RECEIPTS_DATA
• INVENTORY_RESERVED string GET_RESERVED_INVENTORY_DATA
• INVENTORY_FULFILLED string GET_AFN_INVENTORY_DATA
• INVENTORY_MULTICOUNTRY string GET_AFN_INVENTORY_DATA_BY_COUNTRY
• INVENTORY_SUMMARY string GET_LEDGER_SUMMARY_VIEW_DATA
• INVENTORY_HISTORY_DAILY string GET_FBA_FULFILLMENT_CURRENT_INVENTORY_DATA
• INVENTORY_HISTORY_MONTHLY string GET_FBA_FULFILLMENT_MONTHLY_INVENTORY_DATA
• INBOUND_PERFORMANCE string GET_FBA_FULFILLMENT_INBOUND_NONCOMPLIANCE_DATA

GRANULARITY

Type: object

Properties

• HOUR string Hour
• DAY string Day
• WEEK string Week
• MONTH string Month
• YEAR string Year
• TOTAL string Total

SHIPMENT_STATUS

Type: object

Properties

• CLOSED string CLOSED

GetReports

Get a list of reports of specific type

Parameters

• options Object the options (optional, default {})

  • options.type String the report type
  • options.report_type String the report type

Returns Array

GetReport

Get the meta-data of a certain report

Parameters

• options Object the options (optional, default {})

  • options.report_id String the report id

Returns object

CreateReport

Request the creation of a specific type of report for a marketplace

Parameters

• options Object the options

  • options.marketplace String the marketplace (optional, default 'DE')
  • options.report_type String the report type

Returns String

GetDocument

Get report document, containing it’s actual data

Parameters

• options Object the options (optional, default {})

  • options.id String the reportdocument_id
  • options.reportdocument_id String the reportdocument_id (optional, default id)

Returns (Array | Object)

GetOrderMetrics

Get order metrics… I guess?!

Parameters

• options Object the options (optional, default {})

  • options.marketplace String the marketplace (optional, default 'DE')
  • options.from String the interval from date/time (optional, default '2021-03-01T00:00:00-02:00')
  • options.to String the interval to date/time (optional, default '2021-03-04T00:00:00-02:00')

Returns Array

GetShipments

Get all shipments for specified status

Parameters

• options Object the options (optional, default {})

  • options.status Array the shipment status array

Returns Array

GetNewClosedShipments

Get unprocessed, newly closed shipments

Returns Object

GetShipmentItemsForShipment

Get a shipment’s items

Parameters

• options Object the options (optional, default {})

  • options.shipment_id String the shipment id

Returns Array

GetClosedInboundShipments

Get closed inbound shipments

Returns Array