Create Shipment Method

Creates a project-scoped shipping method from the submitted carrier and method details.

GETPOST

Authentication

Requirement: Required
Credential type: Bearer API key
Scopes: Not specified

Permissions

Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.

Headers

Name	Required	Type	Details
`Authorization`	Yes	Not specified	Description: Bearer credential used to authenticate the request.

Path Parameters

Name	Required	Type	Details
`project_id`	Yes	Not specified	Description: Target project identifier.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: UpsertShippingMethodRequest

Field	Required	Type	Details
`carrier_code`	Yes	string	Description: Text value.
`carrier_label`	No	string	Description: Human-readable label.
`method_code`	Yes	string	Description: Text value.
`method_label`	Yes	string	Description: Human-readable label.
`is_active`	No	boolean	Description: Boolean flag.
`sort_order`	No	integer	Description: Integer value.
`meta`	No	JSON	Description: Free-form metadata object.
`use_default`	No	boolean	Description: Boolean flag.

Response Body

Example 200 response

json

{
  "id": 1
}

Errors

400 bad_request

Availability

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

Example request

POST/api/projects/{project_id}/sales/orders/shipments/methods

Base URLhttps://api.modusell.com

curl --request POST \
  --url "https://api.modusell.com/api/projects/example_project_id/sales/orders/shipments/methods" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"carrier_code":"VALUE","carrier_label":"VALUE","method_code":"VALUE","method_label":"VALUE","is_active":true,"sort_order":1,"meta":{},"use_default":true}'

Response

Examples are not available for this release.

Authentication

Required: Bearer API key.