M
ModuSell Developers
ExtensionsStorefronts
extensions / Shipment rules
PATCH/api/projects/{project_id}/sales/shipment-rules/{rule_id}

PATCH /api/projects/{project_id}/sales/shipment-rules/{rule_id}

A description is not available in the current release metadata.

DELETEGETPATCH
Code examples
Integration
PATCH /api/projects/{project_id}/sales/shipment-rules/{rule_id}
EnvironmentBASE_URL
Request
curl --request PATCH \
  --url "${BASE_URL}/api/projects/example_project_id/sales/shipment-rules/example_rule_id" \
  --header "Content-Type: application/json" \
  --data @request.json
Response

Response examples are not available in the current release metadata.

Authentication

Authentication requirements are not specified for this operation.

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Headers

No header metadata is available for this operation.

Path Parameters

NameRequiredType
project_idYesNot specified
rule_idYesNot specified

Query Parameters

No parameter metadata is available for this operation.

Request Body

Schema: UpsertShipmentRuleRequest

FieldRequiredType
nameNoNot specified
descriptionNoNot specified
is_activeNoNot specified
priorityNoNot specified
discard_subsequentNoNot specified
shipping_carriersNoNot specified
shipping_methodsNoNot specified
ignore_free_shipping_promoNoNot specified
calculation_typeNoNot specified
base_rateNoNot specified
fixed_rate_per_productNoNot specified
rate_per_unit_weightNoNot specified

Response Body

Response status codes and response fields are not available in the current release metadata.

Errors

Operation-specific error responses are not available in the current release metadata.

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified