Modify shipment notice

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "warehouse": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "shipmentNoticeOrderItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sku": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorSku": "<string>",
        "vendorCode": "<string>",
        "categoryCode": "<string>",
        "productTitle": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "description": "<string>"
    }
  ],
  "shipmentNoticePackages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "shipmentNoticePackageItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "inventories": [
            {
              "id": "123E4567-E89B-12D3-A456-426614174000",
              "deployStatus": "AWAITING_ARRIVAL",
              "serialNumber": "SN123456789",
              "warehouse": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              }
            }
          ],
          "expectedQuantity": 123,
          "receivedQuantity": 123,
          "skuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "vendorSku": "<string>"
        }
      ],
      "trackingCode": "<string>",
      "shippingCarrier": "<string>",
      "trackingUrl": "<string>"
    }
  ],
  "purchaseOrderNumber": "<string>",
  "expectedShipDate": "2023-12-25",
  "submittedBy": {
    "id": "016fb454-066b-4ba5-9eca-a2fa14b7e7fc",
    "forename": "<string>",
    "surname": "<string>"
  }
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

PATCH

api

shipment-notices

{shipmentNoticeId}

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "warehouse": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "shipmentNoticeOrderItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sku": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorSku": "<string>",
        "vendorCode": "<string>",
        "categoryCode": "<string>",
        "productTitle": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "description": "<string>"
    }
  ],
  "shipmentNoticePackages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "shipmentNoticePackageItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "inventories": [
            {
              "id": "123E4567-E89B-12D3-A456-426614174000",
              "deployStatus": "AWAITING_ARRIVAL",
              "serialNumber": "SN123456789",
              "warehouse": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              }
            }
          ],
          "expectedQuantity": 123,
          "receivedQuantity": 123,
          "skuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "vendorSku": "<string>"
        }
      ],
      "trackingCode": "<string>",
      "shippingCarrier": "<string>",
      "trackingUrl": "<string>"
    }
  ],
  "purchaseOrderNumber": "<string>",
  "expectedShipDate": "2023-12-25",
  "submittedBy": {
    "id": "016fb454-066b-4ba5-9eca-a2fa14b7e7fc",
    "forename": "<string>",
    "surname": "<string>"
  }
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

Authorizations

Authorization

string

header

required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

shipmentNoticeId

string<uuid>

required

Body

application/json

Request body for partially updating a shipment notice. Omit a field to leave it unchanged. Explicit JSON null is rejected unless noted on each field. Editability follows the rules at /api/v1/shipment-notices/{id} GET response status fields: a shipment notice is editable when status is SUBMITTED or when status is PROCESSING and at least one shipment is PENDING.

warehouseId

object

required

New warehouse ID for the shipment notice. Only editable when the shipment notice is editable.

Show child attributes

condition

object

required

New condition. Only editable when shipment notice sourceType is OFFICE; rejected for any other source type.

Show child attributes

purchaseOrderNumber

object

required

New purchase order number.

Show child attributes

shipmentNoticePackages

object

required

Per-package instructions. Omit to leave packages unchanged. Send {id, delete: true} to remove a package. Send {...without id...} to add a new package (only allowed when the shipment notice itself is editable). Send {id, ...fields...} to update a package (only allowed when that package is editable).

Show child attributes

Response

Shipment notice updated

Shipment notice order (V1)

string<uuid>

required

Shipment notice order ID

status

enum<string>

required

Order status

Available options:

SUBMITTED,

PROCESSING,

COMPLETED,

PARTIALLY_COMPLETED,

NOT_COMPLETED,

CANCELLED

sourceType

enum<string>

required

Source type

Available options:

SUPPLIER,

OFFICE

createdAt

string<date-time>

required

Created timestamp

updatedAt

string<date-time>

required

Last updated timestamp

warehouse

object

required

Destination warehouse

Show child attributes

shipmentNoticeOrderItems

object[]

required

Order line items

Show child attributes

shipmentNoticePackages

object[]

required

Packages in this shipment notice

Show child attributes

condition

enum<string>

Condition of items

Available options:

NEW,

USED

purchaseOrderNumber

string

Purchase order number

expectedShipDate

string<date>

Expected ship date

submittedBy

object

Person who submitted the shipment notice.

Show child attributes

Cancel shipment notice Get a single shipment notice order by ID (V1)

⌘I

People

Shipment Notices V1

Returns

Replacements

People — Lifecycle

Packages

Orders

New Joiners

ITAD

Inventory

Inventory Orders

Inventory Levels

Assets

Return Orders

Offices

Warehouses V1

Shipment

Regions V1

Categories

Catalog

Brands

Authorizations

Path Parameters

Body

Response