extensions / Shipment restrictions
PATCH/api/projects/{project_id}/sales/shipment-restrictions/{restriction_id}

PATCH /api/projects/{project_id}/sales/shipment-restrictions/{restriction_id}

A description is not available in the current release metadata.

Code examples
Integration
PATCH /api/projects/{project_id}/sales/shipment-restrictions/{restriction_id}
EnvironmentBASE_URL
Request
curl --request PATCH \
  --url "${BASE_URL}/api/projects/example_project_id/sales/shipment-restrictions/example_restriction_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

Path Parameters

NameRequiredType
project_idYesNot specified
restriction_idYesNot specified

Query Parameters

Request Body

Schema: UpsertShipmentRestrictionRequest

FieldRequiredType
nameNoNot specified
descriptionNoNot specified
is_activeNoNot specified
restricted_carriersNoNot specified
restricted_methodsNoNot specified
show_messageNoNot specified
restriction_messageNoNot specified
show_message_onceNoNot specified
conditionsNoNot specified
admin_area_onlyNoNot specified
customer_rolesNoNot specified
days_of_weekNoNot specified

Response Body

Errors

Availability

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