Struct HttpRequest 

pub struct HttpRequest {
    pub http_method: HttpMethod,
    pub path: String,
    pub body: Option<Value>,
    pub body_type: Option<DataType>,
    pub query: Option<HashMap<String, String>>,
    pub extra_headers: Option<HashMap<String, String>>,
    pub tries: u32,
}

An HTTP request to be sent to the Shopify API.

Use HttpRequest::builder to construct requests with the builder pattern.

Example

use shopify_sdk::clients::{HttpRequest, HttpMethod, DataType};
use serde_json::json;

// GET request
let get_request = HttpRequest::builder(HttpMethod::Get, "products.json")
    .build()
    .unwrap();

// POST request with JSON body
let post_request = HttpRequest::builder(HttpMethod::Post, "products.json")
    .body(json!({"product": {"title": "New Product"}}))
    .body_type(DataType::Json)
    .build()
    .unwrap();

Fields

http_method: HttpMethod

The HTTP method for this request.

path: String

The path (relative to base path) for this request.

body: Option<Value>

The request body, if any.

body_type: Option<DataType>

The content type of the body.

query: Option<HashMap<String, String>>

Query parameters to append to the URL.

extra_headers: Option<HashMap<String, String>>

Additional headers to include in the request.

tries: u32

Number of times to attempt the request (default: 1).

Implementations

impl HttpRequest

pub fn builder( method: HttpMethod, path: impl Into<String>, ) -> HttpRequestBuilder

Creates a new builder for constructing an HttpRequest.

Arguments

• method - The HTTP method for the request
• path - The path (relative to base path) for the request

Example

use shopify_sdk::clients::{HttpRequest, HttpMethod};

let request = HttpRequest::builder(HttpMethod::Get, "products.json")
    .tries(3)
    .build()
    .unwrap();

pub fn verify(&self) -> Result<(), InvalidHttpRequestError>

Validates the request, ensuring it meets all requirements.

Errors

Returns InvalidHttpRequestError if:

• body is Some but body_type is None
• http_method is Post or Put but body is None

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.