v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Shipping Methods

Update shipping method

Updates a Shipping Method

put/api/v1/shippingMethods/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Request body

isActiveboolean

Indicates if the shipping method is active.

namestring

The name of the shipping method.

Example request

{
  "isActive": true,
  "name": "New Carrier",
  "project": {
    "id": "1337"
  },
  "carrier": {
    "carrier": {
      "credentials": {
        "basic": {
          "username": "your-username",
          "password": "your-password"
        }
      },
      "serviceUrl": "https://api.example.com",
      "extra": {
        "field1": "value1",
        "field2": "value2"
      },
      "id": "post-ch",
      "product": {
        "id": "post-ch-express",
        "shipmentType": "outbound"
      }
    }
  },
  "printers": {
    "label": {
      "id": "1337"
    },
    "document": {
      "id": "1337"
    }
  }
}

Response

Operation completed successfully, no response body