Tire Guru
Default module

Purchase Orders

Endpoint:https://api.prod.tireguru.net

Get Purchase Orders

GET
https://api.prod.tireguru.net
/api/v1/purchase_orders

Get Purchase Orders › query Parameters

  • purchase_order_idinteger
  • pageinteger

    Page number to return.

  • pageSizeinteger

    Number of items to return in a page. Defaults to 10.

  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Available fields: purchase_order_number, reference, tracking, total, created_at, locked_at, received_at, eta.

  • filter[supplier_id]string
  • filter[purchase_order_number]string
  • filter[reference]string
  • filter[status]string · enum
    Enum values:
    open
    locked
    received
  • filter[tracking_number]string
  • filter[eta]string
  • filter[shop_id]string

    Primary key of the shop. If not provided, all locations within the company will be included.

  • with_detailsboolean

    When with_details is true, all item data will be returned on the PO

Get Purchase Orders › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Purchase Orders › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Create Purchase Order

POST
https://api.prod.tireguru.net
/api/v1/purchase_orders

Create Purchase Order › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create Purchase Order › Request Body

  • supplier_idnumber · required
  • shop_idnumber · required
  • invoice_numberstring · required

    Required when updating to a received status

  • referencestring
  • trackingstring
  • ship_viastring
  • notesstring
  • etastring
    Example: 2024-07-09T08:35:25.394Z
  • order_bystring

    The name of the user who created the order

  • statusstring · enum

    Defaults to open

    Enum values:
    open
    locked
    received

Create Purchase Order › Responses

  • purchase_order_idnumber · required
  • supplier_idnumber · required
  • shop_idnumber · required
  • supplier_namestring · required
  • purchase_order_numberstring · required
  • referencestring · required
  • trackingstring · required
  • ship_viastring | null · required
  • notesstring | null · required
  • totalnumber · required
  • created_atstring · required
  • locked_atstring | null · required
  • received_atstring | null · required
  • etastring | null · required
  • ordered_bystring · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • itemsobject[]

Get Expense Items

GET
https://api.prod.tireguru.net
/api/v1/purchase_orders/expense_items

Get Expense Items › query Parameters

  • expense_item_idinteger
  • filter[code]string
  • filter[description]string
  • filter[active]boolean

    Defaults to true

  • filter[shop_id]string

    Primary key of the shop. If not provided, all locations within the company will be included.

  • pageinteger

    Page number to return.

  • pageSizeinteger

    Number of items to return in a page. Defaults to 10.

  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column.

Get Expense Items › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Expense Items › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Update Purchase Order

PUT
https://api.prod.tireguru.net
/api/v1/purchase_orders/{purchase_order_id}

Update Purchase Order › path Parameters

  • purchase_order_idstring · required

Update Purchase Order › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Purchase Order › Request Body

  • supplier_idnumber · required
  • shop_idnumber · required
  • invoice_numberstring · required

    Required when updating to a received status

  • referencestring
  • trackingstring
  • ship_viastring
  • notesstring
  • etastring
    Example: 2024-07-09T08:35:25.394Z
  • order_bystring

    The name of the user who created the order

  • statusstring · enum

    Defaults to open

    Enum values:
    open
    locked
    received

Update Purchase Order › Responses

  • purchase_order_idnumber · required
  • supplier_idnumber · required
  • shop_idnumber · required
  • supplier_namestring · required
  • purchase_order_numberstring · required
  • referencestring · required
  • trackingstring · required
  • ship_viastring | null · required
  • notesstring | null · required
  • totalnumber · required
  • created_atstring · required
  • locked_atstring | null · required
  • received_atstring | null · required
  • etastring | null · required
  • ordered_bystring · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • itemsobject[]

Add Item to Purchase Order

POST
https://api.prod.tireguru.net
/api/v1/purchase_orders/{purchase_order_id}/items

Add Item to Purchase Order › path Parameters

  • purchase_order_idstring · required

Add Item to Purchase Order › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Add Item to Purchase Order › Request Body

  • quantitynumber · required
  • item_idnumber

    Required when expense_item_id not provided

  • expense_item_idnumber

    Required when item_id not provided

  • sizestring

    Will override item's size

  • codestring

    Will override item's code

  • descriptionstring

    Will override item's description

  • costnumber

    Will override item's cost

  • fetnumber

    Will override item's fet

  • binstring
  • shop_idnumber

Add Item to Purchase Order › Responses

  • purchase_order_item_idnumber · required
  • costnumber · required
  • quantitynumber · required
  • allocatednumber · required
  • availablenumber · required
  • locked_atrequired
  • received_atrequired
  • backordered_atrequired
  • totalnumber · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • item_id

    Required if expense_id is not provided

  • expense_item_idstring | null
  • codestring
  • sizestring
  • rawsizestring
  • descriptionstring
  • fetnumber | null

Update Purchase Order Item

PUT
https://api.prod.tireguru.net
/api/v1/purchase_orders/{purchase_order_id}/items/{purchase_order_item_id}

Update Purchase Order Item › path Parameters

  • purchase_order_idstring · required
  • purchase_order_item_idstring · required

Update Purchase Order Item › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Purchase Order Item › Request Body

  • quantitynumber · required
  • item_idnumber
  • expense_item_idnumber
  • sizestring

    Will override item's size

  • codestring

    Will override item's code

  • descriptionstring

    Will override item's description

  • costnumber

    Will override item's cost

  • fetnumber

    Will override item's fet

  • binstring

Update Purchase Order Item › Responses

  • purchase_order_item_idnumber · required
  • costnumber · required
  • quantitynumber · required
  • allocatednumber · required
  • availablenumber · required
  • locked_atrequired
  • received_atrequired
  • backordered_atrequired
  • totalnumber · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • item_id

    Required if expense_id is not provided

  • expense_item_idstring | null
  • codestring
  • sizestring
  • rawsizestring
  • descriptionstring
  • fetnumber | null

Receive Purchase Order

POST
https://api.prod.tireguru.net
/api/v1/purchase_orders/{purchase_order_id}/receive

Receive Purchase Order › path Parameters

  • purchase_order_idstring · required

Receive Purchase Order › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Receive Purchase Order › Request Body

  • shop_idnumber · required
  • invoice_numberstring · required

    Required when updating to a received status

Receive Purchase Order › Responses

  • purchase_order_idnumber · required
  • supplier_idnumber · required
  • shop_idnumber · required
  • supplier_namestring · required
  • purchase_order_numberstring · required
  • referencestring · required
  • trackingstring · required
  • ship_viastring | null · required
  • notesstring | null · required
  • totalnumber · required
  • created_atstring · required
  • locked_atstring | null · required
  • received_atstring | null · required
  • etastring | null · required
  • ordered_bystring · required
  • statusstring · enum · required
    Enum values:
    open
    locked
    received
    backordered
  • itemsobject[]
Canned JobNotifications