Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use {id, delete: true} on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting id.
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
string<uuid>
required
New warehouse ID for the shipment notice. Only editable when the shipment notice is editable.
condition
enum<string>
required
New condition. Only editable when shipment notice sourceType is OFFICE; rejected for any other source type.
Available options:
NEW,
USED
purchaseOrderNumber
string
required
New purchase order number.
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)
id
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
null
Person who submitted the shipment notice.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Firstbase API","description":"Integration endpoints for provisioning, inventory, orders, and people management.","colors":{"primary":"#f2555a","light":"#f2555a","dark":"#d94449"},"logo":{"light":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/light.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=e22f02de6760918dfb83ad51b00a4dd8","dark":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/dark.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=8aa1a519222b541c81f34991b82a3990"},"favicon":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/favicon.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=185b8a75ba7c0a1463d02bfb7faba5c7","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"server":"https://apipub.firstbasehq.com"}},"navbar":{"links":[],"primary":{"type":"button","label":"App","href":"https://app.firstbasehq.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Getting Started","icon":"rocket","href":"/"},{"anchor":"Swagger UI","icon":"code","href":"https://apipub.firstbasehq.com/swagger-ui/index.html"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firstbase-cd088419","hasAudioNarration":false,"actualSubdomain":"firstbase-cd088419","customDomains":["developers.firstbase.com"],"gitSource":{"type":"github","owner":"appdirect","repo":"firstbase-app","deployBranch":"development","contentDirectory":"public-api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afc966607e1f860fc0f5845","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"People","count":10},{"language":"default","tag":"Inventory","count":6},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"Packages","count":6},{"language":"default","tag":"Inventory Orders","count":5},{"language":"default","tag":"Returns","count":5},{"language":"default","tag":"Shipment Notices","count":5},{"language":"default","tag":"Catalog","count":4},{"language":"default","tag":"Inventory Levels","count":4},{"language":"default","tag":"ITAD","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/shipment-notices/modify-shipment-notice","slug":"/api-reference/shipment-notices/modify-shipment-notice","pageMetadata":{"title":"Modify shipment notice","description":"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use `{id, delete: true}` on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting `id`.","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/modify-shipment-notice","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use \", _jsx(_components.code, {\n children: \"{id, delete: true}\"\n }), \" on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting \", _jsx(_components.code, {\n children: \"id\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Modify shipment notice","description":"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use `{id, delete: true}` on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting `id`.","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/modify-shipment-notice","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstbase-cd088419/eb8be295fb0c99cf/test/security/dep-versions.test.js","/_mintlify/custom/firstbase-cd088419/a351a42a1eff512c/test/security/qs-dos.test.js"],"openApiReferenceData":{"operation":{"tags":["Shipment Notices"],"summary":"Modify shipment notice","description":"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use `{id, delete: true}` on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting `id`.","operationId":"patchShipmentNotice","parameters":["aec5f040-a2d1-4b2e-827e-53121b1a7757"],"requestBody":"f8408945-86ec-4e0d-accf-94f20ba6292d","responses":{"200":"af5c8d78-86d6-497b-9028-5a34ee382782","400":"5fbf6f54-bcec-4612-87a9-482434423c19","403":"83b43198-87d6-4c58-9b8e-99c88f704b1e","404":"74eece17-d1b0-4b6f-a4d3-069bb66823ef","409":"1e17d5fa-7664-4056-91b7-b9adc1bdccc7"},"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -sS -X PATCH 'https://apipub.firstbasehq.com/api/v1/shipment-notices/{shipmentNoticeId}' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"shipmentNoticePackages\": [\n {\n \"items\": []\n }\n ]\n }'"}],"method":"patch","type":"path","servers":["c72a91e2-ce89-42c6-8eda-72a67db3f3b0"],"security":["1e65b031-3712-4e0e-af72-36a1881b7f28"],"path":"/api/v1/shipment-notices/{shipmentNoticeId}","baseUrlOptions":["https://apipub.firstbasehq.com"],"title":"Modify shipment notice","codeSamples":[{"label":"cURL","lang":"curl","source":"curl -sS -X PATCH 'https://apipub.firstbasehq.com/api/v1/shipment-notices/{shipmentNoticeId}' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"shipmentNoticePackages\": [\n {\n \"items\": []\n }\n ]\n }'"}],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.shipmentNoticePackages.items.0":{"items":[]}}],"urlDisplay":"full"},"dependencies":{"parameters":{"aec5f040-a2d1-4b2e-827e-53121b1a7757":{"name":"shipmentNoticeId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"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.","properties":{"warehouseId":{"type":"string","format":"uuid","description":"New warehouse ID for the shipment notice. Only editable when the shipment notice is editable.","isRequired":true,"uniqueKey":"warehouseId","typeLabel":"string\u003cuuid>"},"condition":{"type":"string","description":"New condition. Only editable when shipment notice sourceType is OFFICE; rejected for any other source type.","enum":["NEW","USED"],"isRequired":true,"uniqueKey":"condition","typeLabel":"enum\u003cstring>"},"purchaseOrderNumber":{"type":"string","description":"New purchase order number.","isRequired":true,"uniqueKey":"purchaseOrderNumber","typeLabel":"string"},"shipmentNoticePackages":{"type":"array","description":"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).","items":{"type":"object","description":"Per-shipment update instruction. See parent description.","properties":{"delete":{"type":"boolean","description":"When true, remove this shipment. Mutually exclusive with all other fields except `id`.","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].delete","typeLabel":"boolean"},"shippingCarrier":{"type":"string","description":"Shipping carrier. Required together with trackingCode when either is present. Both are required when adding a shipment (omit id).","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shippingCarrier","typeLabel":"string"},"trackingCode":{"type":"string","description":"Tracking code. Required together with shippingCarrier when either is present. Both are required when adding a shipment (omit id). tracking_url is server-derived.","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].trackingCode","typeLabel":"string"},"items":{"type":"array","description":"Per-item instructions inside this package. Same add/update/delete semantics as `shipmentNoticePackages[]`.","items":{"type":"object","description":"Per-item update instruction inside a shipment.","properties":{"delete":{"type":"boolean","description":"When true, remove this item. Mutually exclusive with all other fields except `id`.","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].delete","typeLabel":"boolean"},"skuId":{"type":"string","format":"uuid","description":"SKU ID for this item.","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].skuId","typeLabel":"string\u003cuuid>"},"quantity":{"type":"integer","format":"int32","description":"Expected quantity. Maps to domain expectedQuantity.","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"regionId":{"type":"string","format":"uuid","description":"Region ID. Required when the org has MULTI_ENTITY_M1 enabled and regional transfer is disallowed. Enforcement of regional-transfer rules is handled by the domain layer (post-reconcile); violations are returned as a 400 with source 'shipmentNotice' rather than a field-level path.","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].regionId","typeLabel":"string\u003cuuid>"},"id":{"oneOf":[{"type":"string","format":"uuid","description":"Existing item ID. Required for update or delete; omit for additions.","uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Existing item ID. Required for update or delete; omit for additions.","uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["delete","quantity","regionId","skuId"],"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].\\items","typeLabel":"object[]"},"id":{"oneOf":[{"type":"string","format":"uuid","description":"Existing shipment ID. Required for update or delete; omit for additions.","uniqueKey":"shipmentNoticePackages.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Existing shipment ID. Required for update or delete; omit for additions.","uniqueKey":"shipmentNoticePackages.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipmentNoticePackages.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["delete","items","shippingCarrier","trackingCode"],"uniqueKey":"shipmentNoticePackages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipmentNoticePackages","typeLabel":"object[]"}},"required":["condition","purchaseOrderNumber","shipmentNoticePackages","warehouseId"],"uniqueKey":"","typeLabel":"object"},"example":{"shipmentNoticePackages":[{"items":[]}]},"examples":{"Example":{"title":"Example","value":{"shipmentNoticePackages":[{"items":[]}]}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"af5c8d78-86d6-497b-9028-5a34ee382782":{"description":"Shipment notice updated","content":{"application/json":{"schema":{"type":"object","description":"Shipment notice order (V1)","properties":{"id":{"type":"string","format":"uuid","description":"Shipment notice order ID","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Order status","enum":["SUBMITTED","PROCESSING","COMPLETED","PARTIALLY_COMPLETED","NOT_COMPLETED","CANCELLED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"sourceType":{"type":"string","description":"Source type","enum":["SUPPLIER","OFFICE"],"isRequired":true,"uniqueKey":"sourceType","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Created timestamp","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated timestamp","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"warehouse":{"type":"object","description":"Destination warehouse","properties":{"id":{"type":"string","format":"uuid","description":"Warehouse ID","isRequired":true,"uniqueKey":"warehouse.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Warehouse name","uniqueKey":"warehouse.name","typeLabel":"string"}},"required":["id"],"isRequired":true,"uniqueKey":"warehouse","typeLabel":"object"},"shipmentNoticeOrderItems":{"type":"array","description":"Order line items","items":{"type":"object","description":"Shipment notice order item","properties":{"id":{"type":"string","format":"uuid","description":"Item ID","isRequired":true,"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"sku":{"type":"object","description":"SKU reference","properties":{"id":{"type":"string","format":"uuid","description":"SKU ID","isRequired":true,"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].sku.id","typeLabel":"string\u003cuuid>"},"vendorSku":{"type":"string","description":"Vendor SKU code","uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].sku.vendorSku","typeLabel":"string"},"vendorCode":{"type":"string","description":"Vendor code","uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].sku.vendorCode","typeLabel":"string"},"categoryCode":{"type":"string","description":"Category code","uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].sku.categoryCode","typeLabel":"string"},"productTitle":{"type":"string","description":"Product title","uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].sku.productTitle","typeLabel":"string"}},"required":["id"],"isRequired":true,"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].sku","typeLabel":"object"},"status":{"type":"string","description":"Item status","enum":["EXPECTED","PARTIALLY_EXPECTED","NO_LONGER_EXPECTED","RECEIVED","OVER_RECEIVED","PARTIALLY_RECEIVED","NOT_RECEIVED","CANCELLED"],"isRequired":true,"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Created timestamp","isRequired":true,"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated timestamp","isRequired":true,"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"quantity":{"type":"integer","format":"int32","description":"Quantity","uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"description":{"type":"string","description":"Item description","uniqueKey":"shipmentNoticeOrderItems.items.[INDEX].description","typeLabel":"string"}},"required":["createdAt","id","sku","status","updatedAt"],"uniqueKey":"shipmentNoticeOrderItems.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipmentNoticeOrderItems","typeLabel":"object[]"},"shipmentNoticePackages":{"type":"array","description":"Packages in this shipment notice","items":{"type":"object","description":"Shipment notice package (V1)","properties":{"id":{"type":"string","format":"uuid","description":"Package ID","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Created timestamp","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated timestamp","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"shipmentNoticePackageItems":{"type":"array","description":"Package items","items":{"type":"object","description":"Shipment notice package item (V1)","properties":{"id":{"type":"string","format":"uuid","description":"Package item ID","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Created timestamp","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated timestamp","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"inventories":{"type":"array","description":"Inventories associated with this package item, ordered by createdAt asc","items":{"type":"object","description":"Inventory associated with a shipment notice package item (V1)","properties":{"id":{"type":"string","format":"uuid","description":"Inventory ID","example":"123E4567-E89B-12D3-A456-426614174000","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].inventories.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"deployStatus":{"type":"string","description":"Deploy status","enum":["ARCHIVED","AVAILABLE","AWAITING_ARRIVAL","DEPLOYED","GIFTED","LOCKED","ON_HOLD","OUT_FOR_REPAIR","UNAVAILABLE","VOIDED"],"example":"AWAITING_ARRIVAL","isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].inventories.items.[INDEX].deployStatus","typeLabel":"enum\u003cstring>"},"serialNumber":{"type":"string","description":"Serial number","example":"SN123456789","uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].inventories.items.[INDEX].serialNumber","typeLabel":"string"},"warehouse":{"type":"null","description":"Warehouse where the inventory is located","properties":{"id":{"type":"string","format":"uuid","description":"Warehouse ID"},"name":{"type":"string","description":"Warehouse name"}},"required":["id"],"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].inventories.items.[INDEX].warehouse","typeLabel":"null"}},"required":["deployStatus","id"],"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].inventories.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].inventories","typeLabel":"object[]"},"status":{"type":"string","description":"Package item status","enum":["EXPECTED","RECEIVED","PARTIALLY_RECEIVED","OVER_RECEIVED","NOT_RECEIVED","CANCELLED"],"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"expectedQuantity":{"type":"integer","format":"int32","description":"Expected quantity","uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].expectedQuantity","typeLabel":"integer\u003cint32>"},"receivedQuantity":{"type":"integer","format":"int32","description":"Received quantity","uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].receivedQuantity","typeLabel":"integer\u003cint32>"},"skuId":{"type":"string","format":"uuid","description":"SKU ID for this package item","uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].skuId","typeLabel":"string\u003cuuid>"},"vendorSku":{"type":"string","description":"Vendor SKU code","uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX].vendorSku","typeLabel":"string"}},"required":["createdAt","id","inventories","updatedAt"],"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipmentNoticePackages.items.[INDEX].shipmentNoticePackageItems","typeLabel":"object[]"},"status":{"type":"string","description":"Package status","enum":["PENDING","IN_TRANSIT","OUT_FOR_DELIVERY","ARRIVED_AT_PROCESSING_FACILITY","PARTIALLY_RECEIVED","FULLY_RECEIVED","OVER_RECEIVED","NOT_RECEIVED","CANCELLED","DELIVERY_EXCEPTION"],"uniqueKey":"shipmentNoticePackages.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"trackingCode":{"type":"string","description":"Tracking code","uniqueKey":"shipmentNoticePackages.items.[INDEX].trackingCode","typeLabel":"string"},"shippingCarrier":{"type":"string","description":"Shipping carrier","uniqueKey":"shipmentNoticePackages.items.[INDEX].shippingCarrier","typeLabel":"string"},"trackingUrl":{"type":"string","description":"Tracking URL","uniqueKey":"shipmentNoticePackages.items.[INDEX].trackingUrl","typeLabel":"string"}},"required":["createdAt","id","shipmentNoticePackageItems","updatedAt"],"uniqueKey":"shipmentNoticePackages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipmentNoticePackages","typeLabel":"object[]"},"condition":{"type":"string","description":"Condition of items","enum":["NEW","USED"],"uniqueKey":"condition","typeLabel":"enum\u003cstring>"},"purchaseOrderNumber":{"type":"string","description":"Purchase order number","uniqueKey":"purchaseOrderNumber","typeLabel":"string"},"expectedShipDate":{"type":"string","format":"date","description":"Expected ship date","uniqueKey":"expectedShipDate","typeLabel":"string\u003cdate>"},"submittedBy":{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Person ID","example":"016fb454-066b-4ba5-9eca-a2fa14b7e7fc"},"forename":{"oneOf":[{"type":"string","description":"Person's forename / first name"},{"type":"null","description":"Person's forename / first name"}]},"surname":{"oneOf":[{"type":"string","description":"Person's surname / last name"},{"type":"null","description":"Person's surname / last name"}]}},"required":["id"],"description":"Person who submitted the shipment notice.","uniqueKey":"submittedBy","typeLabel":"null"}},"required":["createdAt","id","shipmentNoticeOrderItems","shipmentNoticePackages","sourceType","status","updatedAt","warehouse"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"SUBMITTED","sourceType":"SUPPLIER","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","warehouse":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"shipmentNoticeOrderItems":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","sku":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","vendorSku":"\u003cstring>","vendorCode":"\u003cstring>","categoryCode":"\u003cstring>","productTitle":"\u003cstring>"},"status":"EXPECTED","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","quantity":123,"description":"\u003cstring>"}],"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":null}],"status":"EXPECTED","expectedQuantity":123,"receivedQuantity":123,"skuId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","vendorSku":"\u003cstring>"}],"status":"PENDING","trackingCode":"\u003cstring>","shippingCarrier":"\u003cstring>","trackingUrl":"\u003cstring>"}],"condition":"NEW","purchaseOrderNumber":"\u003cstring>","expectedShipDate":"2023-12-25","submittedBy":null}}},"exampleType":"generated"}},"exampleType":"generated"},"5fbf6f54-bcec-4612-87a9-482434423c19":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"83b43198-87d6-4c58-9b8e-99c88f704b1e":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"74eece17-d1b0-4b6f-a4d3-069bb66823ef":{"description":"Shipment notice not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1e17d5fa-7664-4056-91b7-b9adc1bdccc7":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1e65b031-3712-4e0e-af72-36a1881b7f28":{"ApiKey":{"type":"apiKey","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","name":"Authorization","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"c72a91e2-ce89-42c6-8eda-72a67db3f3b0":{"url":"https://apipub.firstbasehq.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","name":"Authorization","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Authorization","type":"string","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"firstbase-cd088419","siteName":"Firstbase API","title":"Modify shipment notice - Firstbase API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T16:37:07.381Z","originalFileLocation":"api-reference/shipment-notices/modify-shipment-notice.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use {id, delete: true} on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Firstbase API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Modify shipment notice - Firstbase API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use {id, delete: true} on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Firstbase API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=Shipment+Notices\u0026amp;title=Modify+shipment+notice\u0026amp;description=Partially+updates+a+shipment+notice+and+its+packages%2Fitems.+Editability+follows+the+rule%3A+shipment+notice+editable+when+SUBMITTED+or+PROCESSING+with+at+least+on\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=fafdbddabc854febac0ff5e87a7a06d7a6801ae282d6c3d4e1de2747d65e81fa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Modify shipment notice - Firstbase API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use {id, delete: true} on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=Shipment+Notices\u0026amp;title=Modify+shipment+notice\u0026amp;description=Partially+updates+a+shipment+notice+and+its+packages%2Fitems.+Editability+follows+the+rule%3A+shipment+notice+editable+when+SUBMITTED+or+PROCESSING+with+at+least+on\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=fafdbddabc854febac0ff5e87a7a06d7a6801ae282d6c3d4e1de2747d65e81fa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Firstbase API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f2555a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/shipment-notices/modify-shipment-notice.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.firstbase.com/#organization\",\"name\":\"Firstbase API\",\"url\":\"https://developers.firstbase.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/light.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=e22f02de6760918dfb83ad51b00a4dd8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.firstbase.com#website\",\"name\":\"Firstbase API\",\"url\":\"https://developers.firstbase.com\",\"publisher\":{\"@id\":\"https://developers.firstbase.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice#webpage\",\"url\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice\",\"name\":\"Modify shipment notice\",\"description\":\"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use {id, delete: true} on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting id.\",\"dateModified\":\"2026-11-13T16:37:07.381Z\",\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shipment Notices\",\"item\":\"https://developers.firstbase.com/api-reference/shipment-notices/list-shipment-notices\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Modify shipment notice\",\"item\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice#apireference\",\"headline\":\"Modify shipment notice\",\"name\":\"Modify shipment notice\",\"description\":\"Partially updates a shipment notice and its packages/items. Editability follows the rule: shipment notice editable when SUBMITTED or PROCESSING with at least one PENDING package. Use {id, delete: true} on shipmentNoticePackages or items to remove them. Omit elements to preserve them. Add new packages or items by omitting id.\",\"url\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice\",\"mainEntityOfPage\":{\"@id\":\"https://developers.firstbase.com/api-reference/shipment-notices/modify-shipment-notice#webpage\"},\"dateModified\":\"2026-11-13T16:37:07.381Z\",\"publisher\":{\"@id\":\"https://developers.firstbase.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Firstbase API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Firstbase API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/shipment-notices/modify-shipment-notice.md","siteName":"Firstbase API","nav":{"global":{"anchors":[{"anchor":"Getting Started","icon":"rocket","href":"/"},{"anchor":"Swagger UI","icon":"code","href":"https://apipub.firstbasehq.com/swagger-ui/index.html"}]},"groups":[{"group":"Guides","pages":[{"title":"Rate limits","href":"/rate-limits"}]},{"group":"Catalog","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/categories","href":"/api-reference/catalog/list-categories"},{"title":"Get SKU","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/skus/{skuId}","href":"/api-reference/catalog/get-sku"},{"title":"List SKUs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/skus","href":"/api-reference/catalog/list-skus"},{"title":"List brands","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/brands","href":"/api-reference/catalog/list-brands"}]},{"group":"Inventory","pages":[{"title":"Add tags","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory/{inventoryId}/tags","href":"/api-reference/inventory/add-tags"},{"title":"Create asset","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/assets","href":"/api-reference/inventory/create-asset"},{"title":"Get inventory item","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory/{inventoryId}","href":"/api-reference/inventory/get-inventory-item"},{"title":"Update inventory","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory/{inventoryId}","href":"/api-reference/inventory/update-inventory"},{"title":"List inventory","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory","href":"/api-reference/inventory/list-inventory"},{"title":"Remove tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory/{inventoryId}/tags/{tagId}","href":"/api-reference/inventory/remove-tag"}]},{"group":"Inventory Levels","pages":[{"title":"List inventory levels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-levels","href":"/api-reference/inventory-levels/list-inventory-levels"},{"title":"Create inventory level","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory-levels","href":"/api-reference/inventory-levels/create-inventory-level"},{"title":"Update inventory level","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory-levels/{id}","href":"/api-reference/inventory-levels/update-inventory-level"},{"title":"Delete inventory level","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory-levels/{id}","href":"/api-reference/inventory-levels/delete-inventory-level"}]},{"group":"Inventory Orders","pages":[{"title":"List inventory orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-orders","href":"/api-reference/inventory-orders/list-inventory-orders"},{"title":"Create inventory order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory-orders","href":"/api-reference/inventory-orders/create-inventory-order"},{"title":"Modify inventory order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory-orders/{inventoryOrderId}","href":"/api-reference/inventory-orders/modify-inventory-order"},{"title":"Cancel inventory order","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory-orders/{inventoryOrderId}","href":"/api-reference/inventory-orders/cancel-inventory-order"},{"title":"Get inventory order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-orders/{id}","href":"/api-reference/inventory-orders/get-inventory-order"}]},{"group":"ITAD","pages":[{"title":"List ITAD requests","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/requests","href":"/api-reference/itad/list-itad-requests"},{"title":"Create ITAD requests","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/itad/requests","href":"/api-reference/itad/create-itad-requests"},{"title":"Get ITAD request","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/requests/{requestId}","href":"/api-reference/itad/get-itad-request"},{"title":"List eligible assets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/eligible-assets","href":"/api-reference/itad/list-eligible-assets"}]},{"group":"New Joiners","pages":[{"title":"Send reminder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/new-joiners/{personId}/remind","href":"/api-reference/new-joiners/send-reminder"},{"title":"Get new joiner stats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/new-joiners/stats","href":"/api-reference/new-joiners/get-new-joiner-stats"},{"title":"List new joiners","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/new-joiners","href":"/api-reference/new-joiners/list-new-joiners"}]},{"group":"Offices","pages":[{"title":"Modify office","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/offices/{officeId}","href":"/api-reference/offices/modify-office"},{"title":"Get office","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/offices/{id}","href":"/api-reference/offices/get-office"},{"title":"List offices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/offices","href":"/api-reference/offices/list-offices"}]},{"group":"Orders","pages":[{"title":"Decline an order awaiting approval","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/decline","href":"/api-reference/orders/decline-an-order-awaiting-approval"},{"title":"Approve order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/approve","href":"/api-reference/orders/approve-order"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Modify or cancel an existing order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/orders/{orderId}","href":"/api-reference/orders/modify-or-cancel-an-existing-order"}]},{"group":"Packages","pages":[{"title":"Duplicate an existing package","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/packages/{slug}/duplicate","href":"/api-reference/packages/duplicate-an-existing-package"},{"title":"List packages","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/packages","href":"/api-reference/packages/list-packages"},{"title":"Create package","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/packages","href":"/api-reference/packages/create-package"},{"title":"Modify package note","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/packages/{slug}/notes/{noteId}","href":"/api-reference/packages/modify-package-note"},{"title":"Get package","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/packages/{slug}","href":"/api-reference/packages/get-package"},{"title":"Modify package","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/packages/{slug}","href":"/api-reference/packages/modify-package"}]},{"group":"People","pages":[{"title":"Get person","deprecated":null,"version":null,"openapi":"/openapi.json get /scim/v2/Users/{id}","href":"/api-reference/people/get-person"},{"title":"Replace person","deprecated":null,"version":null,"openapi":"/openapi.json put /scim/v2/Users/{id}","href":"/api-reference/people/replace-person"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/openapi.json delete /scim/v2/Users/{id}","href":"/api-reference/people/delete-user"},{"title":"List people","deprecated":null,"version":null,"openapi":"/openapi.json get /scim/v2/Users","href":"/api-reference/people/list-people"},{"title":"Create person","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Users","href":"/api-reference/people/create-person"},{"title":"Bulk upsert users","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Users/csv","href":"/api-reference/people/bulk-upsert-users"},{"title":"Bulk operations","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Bulk","href":"/api-reference/people/bulk-operations"},{"title":"Reactivate person","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/reactivate","href":"/api-reference/people/reactivate-person"},{"title":"Offboard person","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/offboard","href":"/api-reference/people/offboard-person"},{"title":"Send email","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/emails","href":"/api-reference/people/send-email"}]},{"group":"Regions","pages":[{"title":"List regions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/regions","href":"/api-reference/regions/list-regions"},{"title":"Get region","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/regions/{id}","href":"/api-reference/regions/get-region"}]},{"group":"Replacements","pages":[{"title":"List replacements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/replacements","href":"/api-reference/replacements/list-replacements"},{"title":"Create replacement","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/replacements","href":"/api-reference/replacements/create-replacement"},{"title":"Get replacement","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/replacements/{id}","href":"/api-reference/replacements/get-replacement"},{"title":"Cancel replacement","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/replacements/{replacementId}","href":"/api-reference/replacements/cancel-replacement"}]},{"group":"Returns","pages":[{"title":"List returns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Create return","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/returns","href":"/api-reference/returns/create-return"},{"title":"Process return items","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/return-orders/{returnOrderId}/items","href":"/api-reference/returns/process-return-items"},{"title":"Get return","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns/{id}","href":"/api-reference/returns/get-return"},{"title":"Cancel return","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/return-orders/{returnOrderId}","href":"/api-reference/returns/cancel-return"}]},{"group":"Shipment","pages":[{"title":"Get shipment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipments","href":"/api-reference/shipment/get-shipment"},{"title":"List carriers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/carriers","href":"/api-reference/shipment/list-carriers"}]},{"group":"Shipment Notices","pages":[{"title":"List shipment notices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipment-notices","href":"/api-reference/shipment-notices/list-shipment-notices"},{"title":"Create shipment notice","description":"Creates a new shipment notice order. Identify the source as SUPPLIER (with purchase_order_number) or OFFICE. Each shipment contains items identified by sku_id with a quantity.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/shipment-notices","href":"/api-reference/shipment-notices/create-shipment-notice"},{"title":"Modify shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/modify-shipment-notice"},{"title":"Cancel shipment notice","description":"Cancels a shipment notice. Allowed only when notice status is SUBMITTED. Cascades all package item statuses to CANCELLED.","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/cancel-shipment-notice"},{"title":"Get shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipment-notices/{id}","href":"/api-reference/shipment-notices/get-shipment-notice"}]},{"group":"Warehouses","pages":[{"title":"List warehouses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/warehouses","href":"/api-reference/warehouses/list-warehouses"},{"title":"Get warehouse","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/warehouses/{id}","href":"/api-reference/warehouses/get-warehouse"}]}]},"basePath":"","title":"Modify shipment notice - Firstbase API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}