Read a Supplier

GET /suppliers/:id

Status codes

  • 200 on success
  • 404 on supplier not found

Response properties

  • id: The created timestamp of the supplier.
  • name: The assigned name.
  • connect: Boolean, true for connect suppliers.
  • email: The contact email(s) for the supplier. Multiple email addresses can be specified separated by commas. (optional)
  • phone: The contact phone number for the supplier. (optional)
  • website: The contact website for the supplier. (optional)
  • lang: The preferred language for email communication. (optional)
  • min_order_amount: A total amount in cents that is required in the shop when ordering from this supplier. (optional)
  • customer_id: The supplier's reference ID for the account. (optional)
  • price_group: The price group associated with the account. (optional)
  • last_delivery: Timestamp for the last delivery made by this supplier for the account. (optional)
  • preferred_delivery_days: Map representing the preferred delivery schedule. The keys are the days indexed from 0 (Sunday) to 6 (Saturday) and the values are objects: (optional)
    • enabled: Boolean representing if the day is enabled for delivery.
    • time: Time in "HH:MM" string format, representing preferred delivery time. (optional)
  • archived: Timestamp for when the Supplier was archived. (optional)

Example response

{
  "id": 1655819191963,
  "name": "Test Supplier",
  "email": "test-supplier@supplier.com, cc@supplier.com",
  "connect": false,
  "customer_id": "cus_123456",
  "price_group": "zurich-region-2",
  "phone": "076 7798775",
  "last_delivery": 1695113842637
}