Orders

opencollection: 1.0.0
info:
  name: Orders API
  version: 0.1.0
items:
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: Retrieves Orders
      type: http
    http:
      method: GET
      url: https://api.example.com/orders
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Returns a list of all orders for the authenticated user.
  - info:
      name: Orders Create Order
      type: http
    http:
      method: POST
      url: https://api.example.com/orders
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Creating a new order for sending to a recipient.
  - info:
      name: Orders Retrieve Order
      type: http
    http:
      method: GET
      url: https://api.example.com/orders/:orderId
      params:
      - name: orderId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the order to retrieve.
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Returns the details of a specific order.
  - info:
      name: Orders Update Order
      type: http
    http:
      method: PUT
      url: https://api.example.com/orders/:orderId
      params:
      - name: orderId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the order to retrieve.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Updates a single order.
  - info:
      name: Orders Delete Order
      type: http
    http:
      method: DELETE
      url: https://api.example.com/orders/:orderId
      params:
      - name: orderId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the order to retrieve.
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Deletes a order.
  - info:
      name: Orders Cancel Order
      type: http
    http:
      method: PUT
      url: https://api.example.com/orders/:orderId/cancle
      params:
      - name: orderId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the order to retrieve.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Cancels a single order.
bundled: true