Prefix the value with "ApiKey" to indicate the custom authorization type
Body
application/json
Request to create a replacement (return + new order)
personId
string<uuid>
required
ID of the person whose equipment is being replaced
returnItems
object[]
required
Items to return as part of the replacement
Minimum array length: 1
Show child attributes
order
object
required
The replacement order details (new equipment)
Show child attributes
requestAddressConfirmation
boolean
required
Whether to request address confirmation from the person before shipping the return kit
returnKitAddress
object
Address for the return kit shipment. Required when requestAddressConfirmation is false (the default). Omit only when requestAddressConfirmation is true, in which case the person is prompted to confirm their address before the kit ships. If omitted and requestAddressConfirmation is false, the order's shipping address is used.
Show child attributes
officeId
string<uuid>
Office ID for office returns. When set, items are returned to the office via SHIPMENT
Response
Replacement created
Response after creating a replacement
id
string<uuid>
required
Replacement ID
status
enum<string>
required
Current status of the replacement
Available options:
SUBMITTED,
PROCESSING,
COMPLETED,
PARTIALLY_COMPLETED,
CANCELLED
orderId
string<uuid>
ID of the replacement order (new equipment)
returnOrderId
string<uuid>
ID of the return order
{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/replacements/create-replacement","slug":"/api-reference/replacements/create-replacement","pageMetadata":{"title":"Create replacement","description":"Creates a replacement consisting of a return order and a new equipment order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/replacements","href":"/api-reference/replacements/create-replacement","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a replacement consisting of a return order and a new equipment order\"\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":"Create replacement","description":"Creates a replacement consisting of a return order and a new equipment order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/replacements","href":"/api-reference/replacements/create-replacement","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":["Replacements"],"summary":"Create replacement","description":"Creates a replacement consisting of a return order and a new equipment order","operationId":"createReplacement","requestBody":"16ec4368-0ed5-4833-90f9-10b2ba1a3957","responses":{"201":"bc56b9b6-1339-4ec8-835b-5aff43ef4df5","400":"5329a730-1e68-4bdf-ae26-3cbe5fc57ccc","404":"9e6e35e2-e0d4-4e34-8f91-06840a5b471d","409":"ee4ef257-0977-42e1-a955-86f75c0d8405"},"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -sS -X POST 'https://apipub.firstbasehq.com/api/v1/replacements' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"returnItems\": [\n {\n \"inventoryId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"serialNumber\": \"SN-12345\"\n }\n ],\n \"order\": {\n \"skus\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"shippingAddress\": {\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"Apartment B\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"zipCode\": \"94158\",\n \"country\": \"US\",\n \"phoneNumber\": \"+1-555-123-4567\"\n }\n },\n \"returnKitAddress\": {\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"Apartment B\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"zipCode\": \"94158\",\n \"country\": \"US\",\n \"phoneNumber\": \"+1-555-123-4567\"\n }\n }'"}],"method":"post","type":"path","servers":["c72a91e2-ce89-42c6-8eda-72a67db3f3b0"],"security":["1e65b031-3712-4e0e-af72-36a1881b7f28"],"path":"/api/v1/replacements","baseUrlOptions":["https://apipub.firstbasehq.com"],"title":"Create replacement","codeSamples":[{"label":"cURL","lang":"curl","source":"curl -sS -X POST 'https://apipub.firstbasehq.com/api/v1/replacements' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"returnItems\": [\n {\n \"inventoryId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"serialNumber\": \"SN-12345\"\n }\n ],\n \"order\": {\n \"skus\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"shippingAddress\": {\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"Apartment B\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"zipCode\": \"94158\",\n \"country\": \"US\",\n \"phoneNumber\": \"+1-555-123-4567\"\n }\n },\n \"returnKitAddress\": {\n \"addressLine1\": \"123 Main Street\",\n \"addressLine2\": \"Apartment B\",\n \"city\": \"San Francisco\",\n \"state\": \"California\",\n \"zipCode\": \"94158\",\n \"country\": \"US\",\n \"phoneNumber\": \"+1-555-123-4567\"\n }\n }'"}],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.returnItems.items.0.inventoryId":"123e4567-e89b-12d3-a456-426614174000","body.returnItems.items.0.serialNumber":"SN-12345","body.order.skus.items.0.id":"123e4567-e89b-12d3-a456-426614174000","body.order.shippingAddress.addressLine1":"123 Main Street","body.order.shippingAddress.city":"San Francisco","body.order.shippingAddress.zipCode":"94158","body.order.shippingAddress.country":"US","body.order.shippingAddress.addressLine2":"Apartment B","body.order.shippingAddress.state":"California","body.order.shippingAddress.phoneNumber":"+1-555-123-4567","body.returnKitAddress.addressLine1":"123 Main Street","body.returnKitAddress.city":"San Francisco","body.returnKitAddress.zipCode":"94158","body.returnKitAddress.country":"US","body.returnKitAddress.addressLine2":"Apartment B","body.returnKitAddress.state":"California","body.returnKitAddress.phoneNumber":"+1-555-123-4567"}],"urlDisplay":"full"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request to create a replacement (return + new order)","properties":{"personId":{"type":"string","format":"uuid","description":"ID of the person whose equipment is being replaced","isRequired":true,"uniqueKey":"personId","typeLabel":"string\u003cuuid>"},"returnItems":{"type":"array","description":"Items to return as part of the replacement","items":{"type":"object","description":"An item to include in a return or replacement","properties":{"returnReason":{"type":"string","description":"Reason for the return. OFFBOARDING is not allowed via API","enum":["OFFBOARDING","UNKNOWN","OFF_CYCLE","DAMAGED","UPGRADE","STANDARD_LIFECYCLE","PRODUCT_CHANGE","OTHER","LOST_BY_WORKER","LOST_BY_PARTNER","FULFILLMENT_ERROR"],"isRequired":true,"uniqueKey":"returnItems.items.[INDEX].returnReason","typeLabel":"enum\u003cstring>"},"returnMethod":{"type":"string","description":"Return method: SHIPMENT (default) or DROP_OFF. DROP_OFF is only allowed for office returns (when officeId is specified). Warehouse returns must use SHIPMENT","enum":["DROP_OFF","SHIPMENT","MULTIPLE"],"isRequired":true,"uniqueKey":"returnItems.items.[INDEX].returnMethod","typeLabel":"enum\u003cstring>"},"inventoryId":{"type":"string","format":"uuid","description":"Inventory ID of the item to return. Required if serialNumber is not provided","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"returnItems.items.[INDEX].inventoryId","typeLabel":"string\u003cuuid>"},"serialNumber":{"type":"string","description":"Serial number of the item to return. Required if inventoryId is not provided","example":"SN-12345","uniqueKey":"returnItems.items.[INDEX].serialNumber","typeLabel":"string"},"returnReasonComment":{"type":"string","description":"Additional comment about the return reason","uniqueKey":"returnItems.items.[INDEX].returnReasonComment","typeLabel":"string"},"itad":{"type":"boolean","default":false,"description":"Whether to elect this item for ITAD (IT Asset Disposition). Only valid for warehouse returns (not office returns) and ITAD-eligible categories (COMPUTER, MOBILE_PHONE, DRAWING_TABLET, TABLET, EXTERNAL_HDD).","uniqueKey":"returnItems.items.[INDEX].itad","typeLabel":"boolean"},"holdRequested":{"oneOf":[{"type":"boolean","description":"Whether to request a machine retention hold for this item. Only available when this capability is enabled for your organization. When available and the organization's retention policy for the person's region is AD_HOC, set to true to request a hold. Omitted or null is treated as false. Sending this field when the capability is unavailable returns 403.","uniqueKey":"returnItems.items.[INDEX].holdRequested.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to request a machine retention hold for this item. Only available when this capability is enabled for your organization. When available and the organization's retention policy for the person's region is AD_HOC, set to true to request a hold. Omitted or null is treated as false. Sending this field when the capability is unavailable returns 403.","uniqueKey":"returnItems.items.[INDEX].holdRequested.oneOf.1","typeLabel":"null"}],"uniqueKey":"returnItems.items.[INDEX].holdRequested","typeLabel":"boolean | null"}},"required":["returnMethod","returnReason"],"uniqueKey":"returnItems.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"returnItems","typeLabel":"object[]"},"order":{"type":"object","description":"The replacement order details (new equipment)","properties":{"skus":{"type":"array","description":"SKUs to order as replacements","items":{"type":"object","description":"A SKU (product variant) to include in an order, with optional shipping, condition, and create-time fulfillment intent. Clients send sku id + optional intendedFulfillmentMethod only — do not send pricingId, warrantyPricingId, or discountedPrice. When intendedFulfillmentMethod is DROPSHIP and feature flag fbs-4375-one-off-fulfillment-source is on, the server resolves active catalog pricing, warranty pricing, and discount for the order shipping region. WAREHOUSE has no sticky money and is not hard-rejected when warehouse stock is empty. Procurement (DROPSHIP) is not expeditable.","properties":{"id":{"type":"string","format":"uuid","description":"ID of the SKU to order","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"order.skus.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"expeditedShippingOption":{"type":"string","description":"Expedited shipping option for this SKU; null means standard shipping applies","enum":["EXPEDITED_STANDARD"],"uniqueKey":"order.skus.items.[INDEX].expeditedShippingOption","typeLabel":"enum\u003cstring>"},"preferredCondition":{"type":"string","description":"Preferred item condition: NEW (new-only) or USED (used preferred). Omit to default to NEW-only preference","enum":["NEW","USED"],"uniqueKey":"order.skus.items.[INDEX].preferredCondition","typeLabel":"enum\u003cstring>"},"intendedFulfillmentMethod":{"oneOf":[{"type":"string","description":"Create-time fulfillment intent for this line (WAREHOUSE or DROPSHIP). Distinct from fulfill-time fulfillmentMethod on GET responses. Honored when feature flag fbs-4375-one-off-fulfillment-source is on; ignored when the flag is off. Omit/null = legacy create. For DROPSHIP the server resolves catalog pricing/warranty/discount for the shipping region (clients must not send pricing ids). WAREHOUSE maps intent only (no sticky pricing).","enum":["WAREHOUSE","DROPSHIP"],"uniqueKey":"order.skus.items.[INDEX].intendedFulfillmentMethod.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Create-time fulfillment intent for this line (WAREHOUSE or DROPSHIP). Distinct from fulfill-time fulfillmentMethod on GET responses. Honored when feature flag fbs-4375-one-off-fulfillment-source is on; ignored when the flag is off. Omit/null = legacy create. For DROPSHIP the server resolves catalog pricing/warranty/discount for the shipping region (clients must not send pricing ids). WAREHOUSE maps intent only (no sticky pricing).","enum":["WAREHOUSE","DROPSHIP"],"uniqueKey":"order.skus.items.[INDEX].intendedFulfillmentMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.skus.items.[INDEX].intendedFulfillmentMethod","typeLabel":"enum\u003cstring> | null"}},"required":["id"],"uniqueKey":"order.skus.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"order.skus","typeLabel":"object[]"},"shippingAddress":{"type":"object","description":"Shipping address for the replacement order. Required when requestAddressConfirmation is false (the default). May be omitted when requestAddressConfirmation is true, in which case the person is prompted to confirm their address before the replacement ships.","properties":{"addressLine1":{"type":"string","description":"Street address line 1","example":"123 Main Street","minLength":1,"isRequired":true,"uniqueKey":"order.shippingAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","minLength":1,"isRequired":true,"uniqueKey":"order.shippingAddress.city","typeLabel":"string"},"zipCode":{"type":"string","description":"Postal / ZIP code","example":"94158","minLength":1,"isRequired":true,"uniqueKey":"order.shippingAddress.zipCode","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"US","minLength":1,"isRequired":true,"uniqueKey":"order.shippingAddress.country","typeLabel":"string"},"addressLine2":{"type":"string","description":"Street address line 2","example":"Apartment B","uniqueKey":"order.shippingAddress.addressLine2","typeLabel":"string"},"state":{"type":"string","description":"State or province","example":"California","uniqueKey":"order.shippingAddress.state","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number","example":"+1-555-123-4567","uniqueKey":"order.shippingAddress.phoneNumber","typeLabel":"string"}},"required":["addressLine1","city","country","zipCode"],"uniqueKey":"order.shippingAddress","typeLabel":"object"}},"required":["skus"],"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"requestAddressConfirmation":{"type":"boolean","description":"Whether to request address confirmation from the person before shipping the return kit","isRequired":true,"uniqueKey":"requestAddressConfirmation","typeLabel":"boolean"},"returnKitAddress":{"type":"object","description":"Address for the return kit shipment. Required when requestAddressConfirmation is false (the default). Omit only when requestAddressConfirmation is true, in which case the person is prompted to confirm their address before the kit ships. If omitted and requestAddressConfirmation is false, the order's shipping address is used.","properties":{"addressLine1":{"type":"string","description":"Street address line 1","example":"123 Main Street","minLength":1,"isRequired":true,"uniqueKey":"returnKitAddress.addressLine1","typeLabel":"string"},"city":{"type":"string","description":"City","example":"San Francisco","minLength":1,"isRequired":true,"uniqueKey":"returnKitAddress.city","typeLabel":"string"},"zipCode":{"type":"string","description":"Postal / ZIP code","example":"94158","minLength":1,"isRequired":true,"uniqueKey":"returnKitAddress.zipCode","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"US","minLength":1,"isRequired":true,"uniqueKey":"returnKitAddress.country","typeLabel":"string"},"addressLine2":{"type":"string","description":"Street address line 2","example":"Apartment B","uniqueKey":"returnKitAddress.addressLine2","typeLabel":"string"},"state":{"type":"string","description":"State or province","example":"California","uniqueKey":"returnKitAddress.state","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number","example":"+1-555-123-4567","uniqueKey":"returnKitAddress.phoneNumber","typeLabel":"string"}},"required":["addressLine1","city","country","zipCode"],"uniqueKey":"returnKitAddress","typeLabel":"object"},"officeId":{"type":"string","format":"uuid","description":"Office ID for office returns. When set, items are returned to the office via SHIPMENT","uniqueKey":"officeId","typeLabel":"string\u003cuuid>"}},"required":["order","personId","requestAddressConfirmation","returnItems"],"uniqueKey":"","typeLabel":"object"},"example":{"returnItems":[{"inventoryId":"123e4567-e89b-12d3-a456-426614174000","serialNumber":"SN-12345"}],"order":{"skus":[{"id":"123e4567-e89b-12d3-a456-426614174000"}],"shippingAddress":{"addressLine1":"123 Main Street","addressLine2":"Apartment B","city":"San Francisco","state":"California","zipCode":"94158","country":"US","phoneNumber":"+1-555-123-4567"}},"returnKitAddress":{"addressLine1":"123 Main Street","addressLine2":"Apartment B","city":"San Francisco","state":"California","zipCode":"94158","country":"US","phoneNumber":"+1-555-123-4567"}},"examples":{"Example":{"title":"Example","value":{"returnItems":[{"inventoryId":"123e4567-e89b-12d3-a456-426614174000","serialNumber":"SN-12345"}],"order":{"skus":[{"id":"123e4567-e89b-12d3-a456-426614174000"}],"shippingAddress":{"addressLine1":"123 Main Street","addressLine2":"Apartment B","city":"San Francisco","state":"California","zipCode":"94158","country":"US","phoneNumber":"+1-555-123-4567"}},"returnKitAddress":{"addressLine1":"123 Main Street","addressLine2":"Apartment B","city":"San Francisco","state":"California","zipCode":"94158","country":"US","phoneNumber":"+1-555-123-4567"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"bc56b9b6-1339-4ec8-835b-5aff43ef4df5":{"description":"Replacement created","content":{"application/json":{"schema":{"type":"object","description":"Response after creating a replacement","properties":{"id":{"type":"string","format":"uuid","description":"Replacement ID","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Current status of the replacement","enum":["SUBMITTED","PROCESSING","COMPLETED","PARTIALLY_COMPLETED","CANCELLED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"orderId":{"type":"string","format":"uuid","description":"ID of the replacement order (new equipment)","uniqueKey":"orderId","typeLabel":"string\u003cuuid>"},"returnOrderId":{"type":"string","format":"uuid","description":"ID of the return order","uniqueKey":"returnOrderId","typeLabel":"string\u003cuuid>"}},"required":["id","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"SUBMITTED","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","returnOrderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"exampleType":"generated"},"5329a730-1e68-4bdf-ae26-3cbe5fc57ccc":{"description":"Bad request. Returns source \"ASSET_TRACKING_ONLY_GEO\" when the destination country or region is configured as asset-tracking-only.","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"},"9e6e35e2-e0d4-4e34-8f91-06840a5b471d":{"description":"Resource 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"},"ee4ef257-0977-42e1-a955-86f75c0d8405":{"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":"Create replacement - Firstbase API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T16:37:07.185Z","originalFileLocation":"api-reference/replacements/create-replacement.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=\"Creates a replacement consisting of a return order and a new equipment order\">\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=\"Create replacement - Firstbase API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a replacement consisting of a return order and a new equipment order\">\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/replacements/create-replacement\">\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=Replacements\u0026amp;title=Create+replacement\u0026amp;description=Creates+a+replacement+consisting+of+a+return+order+and+a+new+equipment+order\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=8696a5699e5af2552bc9432b2a18db45348d0dddf92cf82faa3a4a67441e6d19\">\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=\"Create replacement - Firstbase API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a replacement consisting of a return order and a new equipment order\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=Replacements\u0026amp;title=Create+replacement\u0026amp;description=Creates+a+replacement+consisting+of+a+return+order+and+a+new+equipment+order\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=8696a5699e5af2552bc9432b2a18db45348d0dddf92cf82faa3a4a67441e6d19\">\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/replacements/create-replacement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/replacements/create-replacement.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/replacements/create-replacement#webpage\",\"url\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement\",\"name\":\"Create replacement\",\"description\":\"Creates a replacement consisting of a return order and a new equipment order\",\"dateModified\":\"2026-11-13T16:37:07.185Z\",\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Replacements\",\"item\":\"https://developers.firstbase.com/api-reference/replacements/list-replacements\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create replacement\",\"item\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement#apireference\",\"headline\":\"Create replacement\",\"name\":\"Create replacement\",\"description\":\"Creates a replacement consisting of a return order and a new equipment order\",\"url\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement\",\"mainEntityOfPage\":{\"@id\":\"https://developers.firstbase.com/api-reference/replacements/create-replacement#webpage\"},\"dateModified\":\"2026-11-13T16:37:07.185Z\",\"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/replacements/create-replacement.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","description":"Returns a paginated list of replacement orders for the organization. A replacement is created when a defective or lost device needs to be swapped for a new one.","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","description":"Returns the details of a single replacement order by its unique identifier.","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","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","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":"Create replacement - 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"]}