Staples

opencollection: 1.0.0
info:
  name: Staples Advantage eProcurement API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Catalog
    type: folder
  items:
  - info:
      name: Search Products
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/catalog/search
      params:
      - name: q
        value: ''
        type: query
        description: Search query string
      - name: category
        value: ''
        type: query
        description: Filter by product category
      - name: brand
        value: ''
        type: query
        description: Filter by brand name
      - name: inStock
        value: ''
        type: query
        description: Filter to in-stock items only
      - name: limit
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
    docs: Search the Staples Advantage product catalog by keyword, category, or SKU. Returns matching products with pricing,
      availability, and contract-specific pricing where applicable.
  - info:
      name: List Categories
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/catalog/categories
    docs: Returns the full Staples Advantage product category hierarchy including office supplies, technology, furniture,
      cleaning, and breakroom categories.
  - info:
      name: Get Product
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/catalog/products/:sku
      params:
      - name: sku
        value: ''
        type: path
        description: The product SKU identifier
    docs: Returns detailed information for a specific product by SKU, including full description, specifications, pricing,
      availability, and related products.
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: List Orders
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/orders
      params:
      - name: status
        value: ''
        type: query
        description: Filter by order status
      - name: startDate
        value: ''
        type: query
      - name: endDate
        value: ''
        type: query
      - name: costCenter
        value: ''
        type: query
        description: Filter by cost center code
      - name: limit
        value: ''
        type: query
    docs: Returns the order history for the authenticated account, filterable by date range, status, and cost center.
  - info:
      name: Create Order
      type: http
    http:
      method: POST
      url: https://api.staplesadvantage.com/v1/orders
      body:
        type: json
        data: '{}'
    docs: Creates a new purchase order from the Staples Advantage catalog with delivery address and cost center allocation.
  - info:
      name: Get Order
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/orders/:orderId
      params:
      - name: orderId
        value: ''
        type: path
        description: The unique identifier of the order
    docs: Returns the full details and current status of a specific order including line items, tracking information, and
      delivery status.
- info:
    name: Account
    type: folder
  items:
  - info:
      name: Get Account
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/account
    docs: Returns the Staples Advantage account details including contract information, approved product lists, and spending
      limits.
  - info:
      name: List Cost Centers
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/account/cost-centers
    docs: Returns all cost center codes configured for the authenticated account for order allocation and expense tracking.
- info:
    name: Delivery
    type: folder
  items:
  - info:
      name: Track Delivery
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/delivery/tracking/:trackingNumber
      params:
      - name: trackingNumber
        value: ''
        type: path
        description: The carrier tracking number
    docs: Returns the current delivery status and tracking history for a specific shipment by tracking number.
- info:
    name: Invoices
    type: folder
  items:
  - info:
      name: List Invoices
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/invoices
      params:
      - name: status
        value: ''
        type: query
        description: Filter by payment status
      - name: startDate
        value: ''
        type: query
      - name: endDate
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: Returns invoice history for the authenticated account, filterable by date range and payment status.
  - info:
      name: Get Invoice
      type: http
    http:
      method: GET
      url: https://api.staplesadvantage.com/v1/invoices/:invoiceId
      params:
      - name: invoiceId
        value: ''
        type: path
        description: The unique identifier of the invoice
    docs: Returns the full details of a specific invoice including line items, amounts, payment status, and associated order
      references.
bundled: true