Skip to content
This repository has been archived by the owner on Feb 6, 2024. It is now read-only.

Commit

Permalink
feat: table of contents update and headers update
Browse files Browse the repository at this point in the history
  • Loading branch information
justinemmanuelmercado committed Jun 26, 2020
1 parent 04b7d5c commit 6c851c4
Showing 1 changed file with 23 additions and 44 deletions.
67 changes: 23 additions & 44 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,37 @@
- [Sections](#sections)
* [Sellers](#sellers)
+ [listMarketplaceParticipations](#listmarketplaceparticipations)
- [Parameters](#parameters)
+ [listMarketplaceParticipationsByNextToken](#listmarketplaceparticipationsbynexttoken)
- [Parameters](#parameters-1)
+ [getServiceStatus](#getservicestatus)
- [Parameters](#parameters-2)
* [Orders](#orders)
+ [listOrders](#listorders)
- [Parameters](#parameters-3)
+ [listOrdersByNextToken](#listordersbynexttoken)
- [Parameters](#parameters-4)
+ [getOrder](#getorder)
- [Parameters](#parameters-5)
+ [listOrderItems](#listorderitems)
- [Parameters](#parameters-6)
+ [listOrderItemsByNextToken](#listorderitemsbynexttoken)
- [Parameters](#parameters-7)
+ [getServiceStatus](#getservicestatus-1)
- [Parameters](#parameters-8)
* [Reports](#reports)
+ [requestReport](#requestreport)
- [Parameters](#parameters-9)
+ [getReportRequestList](#getreportrequestlist)
- [Parameters](#parameters-10)
+ [getReportRequestListByNextToken](#getreportrequestlistbynexttoken)
- [Parameters](#parameters-11)
+ [getReportRequestCount](#getreportrequestcount)
- [Parameters](#parameters-12)
+ [cancelReportRequests](#cancelreportrequests)
- [Parameters](#parameters-13)
+ [getReportList](#getreportlist)
- [Parameters](#parameters-14)
+ [getReportListByNextToken](#getreportlistbynexttoken)
- [Parameters](#parameters-15)
+ [getReportCount](#getreportcount)
- [Parameters](#parameters-16)
+ [getReport](#getreport)
- [Parameters](#parameters-17)
+ [manageReportSchedule](#managereportschedule)
- [Parameters](#parameters-18)
+ [getReportScheduleList](#getreportschedulelist)
- [Parameters](#parameters-19)
+ [getReportScheduleListByNextToken](#getreportschedulelistbynexttoken)
+ [getReportScheduleCount](#getreportschedulecount)
- [Parameters](#parameters-20)
+ [updateReportAcknowledgements](#updatereportacknowledgements)
- [Parameters](#parameters-21)
* [Subscriptions](#subscriptions)
* [FulfillmentInventory](#fulfillmentinventory)
* [Feeds](#feeds)
* [Products](#products)
* [Finances](#finances)


# Basics

amazon-mws-api-sdk is divided up into different sections representing the different sections of the Amazon MWS API.
Expand All @@ -68,20 +47,20 @@ Under each section are methods that perform "actions" on the MWS API parses the
[Amazon MWS Sellers API official documentation](http://docs.developer.amazonservices.com/en_CA/sellers/Sellers_Overview.html)

### listMarketplaceParticipations
#### Parameters
**Parameters**

| None |
|------|

### listMarketplaceParticipationsByNextToken

#### Parameters
**Parameters**
| Name | Type | Example | Required |
|-----------|-----------|-----------------------------------------------------------------------|----------|
| NextToken | NextToken | new NextToken('action', 'nexttoken')<br>See examples for sample usage | Yes |
### getServiceStatus

#### Parameters
**Parameters**

| None |
|------|
Expand All @@ -91,7 +70,7 @@ Under each section are methods that perform "actions" on the MWS API parses the
[Amazon MWS Orders API official documentation](http://docs.developer.amazonservices.com/en_CA/orders-2013-09-01/Orders_Overview.html)

### listOrders
#### Parameters
**Parameters**

| Name | Type | Example | Required |
|--------------------|----------|----------------------------|-----------------------------------------|
Expand All @@ -111,30 +90,30 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for FulfillmentChannel, PaymentMethod and EasyShipmentStatus ](http://docs.developer.amazonservices.com/en_CA/orders-2013-09-01/Orders_ListOrders.html)

### listOrdersByNextToken
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|-----------|-----------|-----------------------------------------------------------------------|----------|
| NextToken | NextToken | new NextToken('action', 'nexttoken')<br>See examples for sample usage | Yes |

### getOrder
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|---------------|----------|-------------------------|----------|
| AmazonOrderId | string[] | ['902-3159896-1390916'] | Yes |

### listOrderItems
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|---------------|--------|-----------------------|----------|
| AmazonOrderId | string | '902-3159896-1390916' | Yes |
### listOrderItemsByNextToken
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|-----------|-----------|-----------------------------------------------------------------------|----------|
| NextToken | NextToken | new NextToken('action', 'nexttoken')<br>See examples for sample usage | Yes |
### getServiceStatus

#### Parameters
**Parameters**

| None |
|------|
Expand All @@ -144,7 +123,7 @@ Under each section are methods that perform "actions" on the MWS API parses the
[Amazon MWS Reports API official documentation](http://docs.developer.amazonservices.com/en_CA/reports/Reports_Overview.html)

### requestReport
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|------------------- |---------- |-------------------------------------- |---------- |
| ReportType | string | '_GET_FLAT_FILE_OPEN_LISTINGS_DATA_' | Yes |
Expand All @@ -156,7 +135,7 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for ReportType](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### getReportRequestList
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|---------------------------- |---------- |---------------------------------------- |------------------------------------------------------------------------------- |
| ReportRequestIdList | string[] | ['12345'] | No. If you pass in ReportRequestId values, other query conditions are ignored |
Expand All @@ -170,13 +149,13 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for ReportTypeList](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### getReportRequestListByNextToken
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|-----------|-----------|-----------------------------------------------------------------------|----------|
| NextToken | NextToken | new NextToken('action', 'nexttoken')<br>See examples for sample usage | Yes |

### getReportRequestCount
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|---------------------------- |---------- |---------------------------------------- |---------- |
| ReportTypeList | string[] | ['_GET_FLAT_FILE_OPEN_LISTINGS_DATA_'] | No |
Expand All @@ -187,7 +166,7 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for ReportTypeList](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### cancelReportRequests
#### Parameters
**Parameters**

| Name | Type | Example | Required |
|---------------------------- |---------- |---------------------------------------- |---------- |
Expand All @@ -201,7 +180,7 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for ReportTypeList](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### getReportList
#### Parameters
**Parameters**

| Name | Type | Example | Required |
|--------------------- |---------- |---------------------------------------- |---------- |
Expand All @@ -215,14 +194,14 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for ReportTypeList](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### getReportListByNextToken
#### Parameters
**Parameters**

| Name | Type | Example | Required |
|-----------|-----------|-----------------------------------------------------------------------|----------|
| NextToken | NextToken | new NextToken('action', 'nexttoken')<br>See examples for sample usage | Yes |

### getReportCount
#### Parameters
**Parameters**

| Name | Type | Example | Required |
|------------------- |---------- |---------------------------------------- |---------- |
Expand All @@ -234,13 +213,13 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for ReportTypeList](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### getReport
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|------------------- |--------- |------------ |---------- |
| ReportId | string | '12345' | Yes |

### manageReportSchedule
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|----------------- |-------- |-------------------------------------- |---------- |
| ReportType | string | '_GET_FLAT_FILE_OPEN_LISTINGS_DATA_' | Yes |
Expand All @@ -250,7 +229,7 @@ Under each section are methods that perform "actions" on the MWS API parses the
* [Possible values for Schedule](http://docs.developer.amazonservices.com/en_CA/reports/Reports_Schedule.html)

### getReportScheduleList
#### Parameters
**Parameters**

| Name | Type | Example | Required |
|------------------- |---------- |---------------------------------------- |---------- |
Expand All @@ -261,14 +240,14 @@ Under each section are methods that perform "actions" on the MWS API parses the
[Currently this operation can never be called because the GetReportScheduleList operation cannot return more than 100 results. It is included for future compatibility.](http://docs.developer.amazonservices.com/en_CA/reports/Reports_GetReportScheduleListByNextToken.html)

### getReportScheduleCount
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|------------------- |---------- |---------------------------------------- |---------- |
| ReportTypeList | string[] | ['_GET_FLAT_FILE_OPEN_LISTINGS_DATA_'] | No |
* [Possible values for ReportTypeList](http://docs.developer.amazonservices.com/en_CA/reports/Reports_ReportType.html)

### updateReportAcknowledgements
#### Parameters
**Parameters**
| Name | Type | Example | Required |
|----------------- |---------- |------------ |---------- |
| ReportIdList | string[] | ['12345'] | Yes |
Expand Down

0 comments on commit 6c851c4

Please sign in to comment.