PickupConsignment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PickupConsignment",
  "title": "PickupConsignment",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "example": 3
    },
    "lineItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConsignmentLineItem"
      }
    },
    "pickupMethodId": {
      "type": "integer",
      "example": 10
    },
    "pickupMethodDisplayName": {
      "type": "string",
      "example": "Pickup Method 10: Pickup at Location 1"
    },
    "collectionInstructions": {
      "type": "string",
      "example": "Pickup Method 10 Collection Instructions"
    },
    "collectionTimeDescription": {
      "type": "string",
      "example": "Pickup Method 10 Collection Time Description"
    },
    "location": {
      "$ref": "#/components/schemas/PickupConsignmentLocation"
    }
  },
  "description": "Pickup consignment",
  "x-examples": {
    "example-1": {
      "id": 3,
      "lineItems": [
        {
          "id": 4
        }
      ],
      "pickupMethodId": 10,
      "pickupMethodDisplayName": "Pickup Method 10: Pickup at Location 1",
      "collectionInstructions": "Pickup Method 10 Collection Instructions",
      "collectionTimeDescription": "Pickup Method 10 Collection Time Description",
      "location": {
        "id": 1,
        "name": "Location 1",
        "address1": "2802 Skyway Cir",
        "address2": "string",
        "city": "Austin",
        "stateOrProvince": "Texas",
        "postalCode": "78704",
        "country": "United States",
        "countryCode": "US",
        "email": "loc1@bigcommerce.com",
        "phone": "0410123452"
      }
    }
  },
  "x-internal": false
}