Create Consignment Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateConsignmentRequest",
  "title": "Create Consignment Request",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "address": {
        "title": "Address Properties",
        "required": [
          "country_code",
          "email"
        ],
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "description": ""
          },
          "last_name": {
            "type": "string",
            "description": ""
          },
          "email": {
            "type": "string",
            "description": ""
          },
          "company": {
            "type": "string",
            "description": ""
          },
          "address1": {
            "type": "string",
            "description": ""
          },
          "address2": {
            "type": "string",
            "description": ""
          },
          "city": {
            "type": "string",
            "description": ""
          },
          "state_or_province": {
            "type": "string",
            "description": "Represents state or province."
          },
          "state_or_province_code": {
            "type": "string",
            "description": ""
          },
          "country_code": {
            "type": "string",
            "description": ""
          },
          "postal_code": {
            "type": "string",
            "description": ""
          },
          "phone": {
            "type": "string",
            "description": ""
          },
          "custom_fields": {
            "type": "array",
            "description": "You can retrieve custom fields from the [Get Form Fields](/docs/rest-storefront/forms#get-form-fields) endpoint.",
            "items": {
              "title": "Custom Field",
              "type": "object",
              "properties": {
                "field_id": {
                  "type": "string",
                  "description": "You must provide the form field ID value as the `field_id`."
                },
                "field_value": {
                  "type": "string",
                  "description": "This can also be an array for fields that need to support a list of values (e.g., a set of check boxes.)"
                }
              },
              "required": [
                "field_id"
              ]
            }
          }
        }
      },
      "line_items": {
        "type": "array",
        "description": "",
        "items": {
          "title": "Consignment Line Item",
          "required": [
            "item_id",
            "quantity"
          ],
          "type": "object",
          "properties": {
            "item_id": {
              "type": "string",
              "description": "Corresponds to `line_items.physical_items[N].id` value from `GET`checkout response."
            },
            "quantity": {
              "type": "integer",
              "description": "",
              "format": "int32"
            }
          }
        }
      },
      "pickup_option": {
        "type": "object",
        "description": "Assigns a pickup consignment. Note: You cannot assign a shipping method with a pickup consignment.",
        "properties": {
          "pickup_method_id": {
            "type": "integer",
            "example": 1
          }
        }
      }
    }
  },
  "x-internal": false
}