Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Packing Slips API

3 actions 3 updates phrasing extends openapi/lightspeed-packing-slips-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Lightspeed Commerce's API. It is a proposal applied on top of the contract, not a document Lightspeed Commerce publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/packing_slip/{fulfillment_id}'].get
$.paths['/partial_packing_slip/{fulfillment_id}'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Packing Slips API
  version: 1.0.0
extends: openapi/lightspeed-packing-slips-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/packing_slip/{fulfillment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Render a full packing slip for a fulfillment
      effect: read
      questions:
      - How do I print a packing slip for an order fulfillment?
      - Can I render the packing slip in another language?
      instructions:
      - text: Render the full packing slip for fulfillment {fulfillment_id}.
        slots:
          fulfillment_id: path.fulfillment_id
      - text: Generate the packing slip for fulfillment {fulfillment_id} in language {lang}.
        slots:
          fulfillment_id: path.fulfillment_id
          lang: query.lang
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partial_packing_slip/{fulfillment_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a partial packing slip for packed items
      effect: read
      questions:
      - Can I print a packing slip for only the items packed so far?
      - How do I make a packing slip for part of a pick list group?
      instructions:
      - text: Render a partial packing slip for pick list group {fulfillment_id} with packed items {packed_line_items}.
        slots:
          fulfillment_id: path.fulfillment_id
          packed_line_items: requestBody.packed_line_items
      - text: Print a slip covering only packed lines {packed_line_items} for group {fulfillment_id} in {lang}.
        slots:
          packed_line_items: requestBody.packed_line_items
          fulfillment_id: path.fulfillment_id
          lang: requestBody.lang
      method: generated
      generated: '2026-09-26'