u

src/api/openapi.js

@@ -1023,8 +1023,28 @@
  *                 $ref: '#/components/schemas/Payment'
  *             paid:
  *               type: boolean
+ *               description: True when paidTotal equals orderTotal
+ *             shipped:
+ *               type: boolean
+ *               description: True when shippedQuantity equals orderedQuantity
  *             delivered:
  *               type: boolean
+ *             orderTotal:
+ *               type: number
+ *               description: Gross sum across order positions
+ *             paidTotal:
+ *               type: number
+ *               description: Sum of all payments connected to order
+ *             orderedQuantity:
+ *               type: number
+ *               description: Total ordered items
+ *             shippedQuantity:
+ *               type: number
+ *               description: Total shipped items across order shipments
+ *             shipments:
+ *               type: array
+ *               items:
+ *                 $ref: '#/components/schemas/Shipment'
  *     ArticleImage:
  *       type: object
  *       required: [picId, sort, full, thumb, hash, thumbHash]
@@ -1209,10 +1229,53 @@
  *         number:
  *           type: string
  *           description: Shipping number from the `shipping` number sequence
+ *         trackingCode:
+ *           type: string
+ *           nullable: true
+ *           description: Carrier parcel tracking code
+ *         carrier:
+ *           type: string
+ *           nullable: true
+ *           description: Carrier name (e.g. DHL, UPS, DPD)
  *         type:
  *           type: string
  *         state:
  *           type: string
+ *     Shipment:
+ *       type: object
+ *       required: [id, number, type, date, lines, shippings]
+ *       properties:
+ *         id:
+ *           type: integer
+ *         number:
+ *           type: string
+ *           description: Shipment compound number `<orderNumber><shipmentPrefix><y>`
+ *         type:
+ *           type: string
+ *           enum: [shipment]
+ *         entityId:
+ *           type: integer
+ *           nullable: true
+ *         externalNumber:
+ *           type: string
+ *           nullable: true
+ *         date:
+ *           type: string
+ *         createdAt:
+ *           type: string
+ *           nullable: true
+ *         lineCount:
+ *           type: integer
+ *         packageCount:
+ *           type: integer
+ *         lines:
+ *           type: array
+ *           items:
+ *             $ref: '#/components/schemas/ManifestLine'
+ *         shippings:
+ *           type: array
+ *           items:
+ *             $ref: '#/components/schemas/Shipping'
  *     Package:
  *       type: object
  *       required: [id, shippingId, entityaddressId, number, type, state]