REST checkout
  • 13 Oct 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

REST checkout

  • Dark
    Light

Article summary

This Checkout will perform up to five parallel REST requests to given endpoints. The endpoint should return successful HTTP code (200-299). Requests are defined via a Hive record, with the following structure:

[{
  Method : "",
  Url : "",
  Content : "",
  ContentEncoding : Encoding.Utf8,
  AuthIntegration : "", // deprecated
  Headers : [
    { Key : "Content-Type", Value : "" },
      RestShop.BasicAuth("username", "password") // (optional) helper method if basic auth is required
  ]
}]

Limits\Restrictions

  • Maximum size for all requests (content + headers) is 10 MB
  • Maximum of 5 requests
  • Supported HTTP methods: POST, GET, PUT, DELETE, HEAD, OPTIONS, TRACE
  • Pending requests will be cancelled after 60 seconds
  • If an exception occurred or the response code was 408 (RequestTimeout), 500 (InternalServerError), 502 (BadGateway), 503 (ServiceUnavailable) or 504 (GatewayTimeout) the call will be retried up to three times.
  • For GET and HEAD calls, the content will be omitted
  • Currently only text files are allowed as request body (e.g. XML, CSV, JSON, form data, ...).

Was this article helpful?

What's Next