Chilkat Online Tools

Ruby / Selling Partner API for Reports / create Report Schedule

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "marketplaceIds": [
#     "<string>"
#   ],
#   "period": "PT1H",
#   "reportType": "<string>",
#   "reportOptions": {
#     "nisi_e65": "<string>",
#     "labore_7d": "<string>"
#   },
#   "nextReportCreationTime": "<dateTime>"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("marketplaceIds[0]","<string>")
json.UpdateString("period","PT1H")
json.UpdateString("reportType","<string>")
json.UpdateString("reportOptions.nisi_e65","<string>")
json.UpdateString("reportOptions.labore_7d","<string>")
json.UpdateString("nextReportCreationTime","<dateTime>")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "reportScheduleId": "<string>"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

reportScheduleId = jResp.stringOf("reportScheduleId")

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "marketplaceIds": [
    "<string>"
  ],
  "period": "PT1H",
  "reportType": "<string>",
  "reportOptions": {
    "nisi_e65": "<string>",
    "labore_7d": "<string>"
  },
  "nextReportCreationTime": "<dateTime>"
}'
https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules

Postman Collection Item JSON

{
  "name": "create Report Schedule",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "reports",
        "2021-06-30",
        "schedules"
      ]
    },
    "description": "Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)."
  },
  "response": [
    {
      "name": "Success.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"reportScheduleId\": \"<string>\"\n}"
    },
    {
      "name": "Request has missing or invalid parameters and cannot be parsed.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "The specified resource does not exist.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "The request's Content-Type header is invalid.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Unsupported Media Type",
      "code": 415,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "The frequency of requests was greater than allowed.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Temporary overloading or maintenance of the server.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"marketplaceIds\": [\n    \"<string>\"\n  ],\n  \"period\": \"PT1H\",\n  \"reportType\": \"<string>\",\n  \"reportOptions\": {\n    \"nisi_e65\": \"<string>\",\n    \"labore_7d\": \"<string>\"\n  },\n  \"nextReportCreationTime\": \"<dateTime>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/reports/2021-06-30/schedules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "reports",
            "2021-06-30",
            "schedules"
          ]
        }
      },
      "status": "Service Unavailable",
      "code": 503,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "x-amzn-RateLimit-Limit",
          "value": "<string>",
          "description": {
            "content": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
            "type": "text/plain"
          }
        },
        {
          "key": "x-amzn-RequestId",
          "value": "<string>",
          "description": {
            "content": "Unique request reference identifier.",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    },\n    {\n      \"code\": \"<string>\",\n      \"message\": \"<string>\",\n      \"details\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}