Show a shipping method

GET/v1/api/store/{team_slug}/setting/shipping_type/{hash_id}

v1Operation ID v1_public_shipping_type_show

Returns one shipping method, deleted or not.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The shipping method's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example 1aNKrP6pU0uytN

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (10)

  • defaultbooleanrequired

    Whether it is the team's default shipping method.

  • external_integration_idstring | nullrequired

    The carrier integration, for integration methods.

  • idstringrequired
  • min_priceintegerrequired

    The Minimum Price. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities. Stored only, like price_type.

  • namestringrequired
  • price_percentintegerrequired

    The Markup Percentage or Margin Percentage as a percentage ×1000: 8250 is 8.25%, 10000 is 10%. Stored only, like price_type.

  • price_typestringrequired

    Pricing calculation type: markup (markup percentage on carrier cost) or margin (profit margin percentage). Stored and displayed in the web app; the API does not apply this calculation to shipment prices.

    • One of: "markup", "margin"
  • service_codestring | nullrequired

    The carrier's service code, for integration methods.

  • trashedbooleanrequired

    True for a deleted shipping method.

  • typestringrequired

    courier, self_delivery, pick_up: your own methods. integration: a service of a connected carrier integration. integration_shippo and shopify_fulfillment are made by YoPrint.

    • One of: "courier", "self_delivery", "pick_up", "integration", "integration_shippo", "shopify_fulfillment"
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• PATCHMake a shipping method the default/v1/api/store/{team_slug}/setting/shipping_type/{hash_id}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/shipping_type/1aNKrP6pU0uytN' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "default": true,
    "external_integration_id": null,
    "id": "1aNKrP6pU0uytN",
    "min_price": 0,
    "name": "Pick Up",
    "price_percent": 0,
    "price_type": "markup",
    "service_code": null,
    "trashed": false,
    "type": "pick_up"
  },
  "status": 200,
  "success": true
}