XExentral
Shipping Methods

View shipping method

Changed on

Shows the details of a Shipping Method

get/api/v1/shippingMethods/{id}

Request

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

type'genericCarrier'

The type of the carrier

isActiveboolean

Determines whether the shipping Method is currently active.

namestring

The human readable name you would like to give to this carrier

shippingEmailBehaviour'default behaviour' | 'no dispatch email' | 'custom text template'

Email behavior for shipping notifications

supportDeliveriesboolean

Whether this shipping method supports deliveries

supportReturnsboolean

Whether this shipping method supports returns

Example response

{
  "type": "genericCarrier",
  "isActive": true,
  "name": "New generic Carrier",
  "project": {
    "id": "1337"
  },
  "carrier": {
    "carrier": {
      "credentials": {
        "basic": {
          "username": "your-username",
          "password": "your-password"
        }
      },
      "serviceUrl": "https://api.example.com",
      "id": "post-ch",
      "product": {
        "id": "post-ch-express",
        "shipmentType": "outbound"
      }
    }
  },
  "shippingLabelPrinter": {
    "id": "1337"
  },
  "exportDocumentPrinter": {
    "id": "1337"
  },
  "shippingEmailBehaviour": "default behaviour",
  "textTemplate": {
    "id": "77",
    "type": "Template Type"
  },
  "supportDeliveries": true,
  "supportReturns": true
}

Changes

  • ebe5ba2a4ed8Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the non-success response with the status