SbPublicApiShipmentResponse

snowbee.SbPublicApiShipmentResponse

object · non-null

captureIdstringnon-nullrequired

Reference to the capture (picking list) this shipment originated from

Example"01234567-89ab-cdef-0123-456789abcdef"

createdDatestringnullableoptional

Date the shipment was created

Format: date

Example"2024-06-16"

idstringnon-nullrequired

Example"01234567-89ab-cdef-0123-456789abcdef"

linesarray of objectnon-nullrequired

Show item fields

lineItemIdstringnon-nullrequired: Reference to order line item
Example"01234567-89ab-cdef-0123-456789abcdef"
quantitystringnon-nullrequired: Quantity shipped
Format: BigDecimal
Example"2.0"

trackingNumberstringnullableoptional

Example"1Z999AA10123456784"

trackingUrlstringnullableoptional

Example"https://track.example.com/1Z999AA10123456784"

View raw schema

{
  "type": "object",
  "properties": {
    "captureId": {
      "type": "string",
      "description": "Reference to the capture (picking list) this shipment originated from",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "createdDate": {
      "type": [
        "null",
        "string"
      ],
      "format": "date",
      "description": "Date the shipment was created",
      "example": "2024-06-16",
      "title": "LocalDate"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiShipmentLineResponse"
      },
      "title": "List<SbPublicApiShipmentLineResponse>"
    },
    "trackingNumber": {
      "type": [
        "null",
        "string"
      ],
      "example": "1Z999AA10123456784",
      "title": "String"
    },
    "trackingUrl": {
      "type": [
        "null",
        "string"
      ],
      "example": "https://track.example.com/1Z999AA10123456784",
      "title": "String"
    }
  },
  "required": [
    "captureId",
    "id",
    "lines"
  ],
  "title": "SbPublicApiShipmentResponse"
}