As a merchant, you should include is_acknowledged=0 as a query string parameter to get only new invoices.
Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint doesn’t return processed shipments.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fabric","colors":{"primary":"#ff2ec1","light":"#ff2ec1","dark":"#ff2ec1"},"logo":{"light":"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872","dark":"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872","href":"https://developer.fabric.inc"},"favicon":"https://mintcdn.com/fabric-demo/ZXHlkaduf1S9hYir/neon-favicon.webp?fit=max\u0026auto=format\u0026n=ZXHlkaduf1S9hYir\u0026q=85\u0026s=fc87341b907a3b0ed573af9c896468b2","navbar":{"primary":{"type":"button","label":"Request Demo","href":"https://fabric.inc/demo-request"}},"footer":{"socials":{"twitter":"https://twitter.com/fabric_commerce?lang=en","linkedin":"https://www.linkedin.com/company/teamfabric"}},"integrations":{"ga4":{"measurementId":"G-5RS60WM116"}},"contextual":{"options":["copy","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fabric-demo","hasAudioNarration":false,"actualSubdomain":"fabric-demo","customDomains":["developer.fabric.inc"],"gitSource":{"type":"gitlab","owner":"fabric2/docs","repo":"developer-docs","projectId":58049997,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a27c05109a51e5ad494d5d6","collectionId":"7afabdbc-2ae6-4c34-9795-efeea513c17c","schemaVersion":"v3"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a905beb40741431493de2c3:failure","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":721},{"language":"default","tag":"Orders \u0026 Inventory","count":276},{"language":"default","tag":"Product Catalog","count":245},{"language":"default","tag":"Dropship","count":242},{"language":"default","tag":"Orders v2 (OMS v2)","count":162},{"language":"default","tag":"Orders API Endpoints","count":145},{"language":"default","tag":"Customer","count":144},{"language":"default","tag":"Offers","count":118},{"language":"default","tag":"Product Catalog API","count":102},{"language":"default","tag":"Orders v1 (OMS v1)","count":100}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tDMPKzSQ.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tMMPKzSQ.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tCMPI.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLucXtAKPY.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLufntAKPY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLucHtA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTucXtAKPY.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTufntAKPY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTucHtA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJbecmNE.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJnecmNE.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJfecg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\na,body,h1,h2,h3,h4,h5,h6,html,p,span{font-family:Poppins}#navbar,#navbar .bg-background-light{background:#000}#navbar #search-bar-entry{background:rgb(var(--background-dark)/var(--tw-bg-opacity))}#navbar [id^=radix].bg-background-light{border-radius:8px;background:#fff;color:rgb(var(--gray-500));border:0}#navbar .dark\\:text-gray-300{color:rgb(var(--gray-300))}#navbar .dark\\:bg-primary-light{--tw-bg-opacity:1;background-color:rgb(var(--primary-light)/var(--tw-bg-opacity))}#navbar .text-gray-800{color:rgb(var(--gray-200))}#navbar .text-gray-600{color:#d4d4d4}#topbar-cta-button .rounded-full,#topbar-cta-button .rounded-full:is(.dark *){border-radius:31px;background:#000;box-shadow:0 7.57px 30.28px 0 rgba(0,0,0,.08);border:0}#topbar-cta-button .dark\\:text-primary-light,#topbar-cta-button .dark\\:text-primary-light:is(.dark *){color:#fff;text-align:center;font-size:14px;font-style:normal;font-weight:500;line-height:20px;letter-spacing:-.084px}.bodyContainer{max-width:63rem;margin:auto;background:0 0}.bodyFull{background:url(images/hero-background-unmasked-1.svg);position:relative;overflow:hidden}.bodyContainer:is(.dark *),.bodyFull:is(.dark *){background-color:transparent}.box-full{border-radius:8px;box-shadow:0 7.57px 30.28px 0 rgba(0,0,0,.08);padding:16px 20px}.box-full:is(.dark *){background-color:#4d354d;border:1px solid rgba(255,255,255,.2)}button p{font-size:18px}button .bg-primary-light{background-color:#121213}.twocol-cntr{width:75%;margin:auto;margin-top:1rem}.gap-x-4{column-gap:1rem;row-gap:1rem}.pink-boxes .card.block{background-color:#fff;border:1px solid #d9acd9;height:161px}.pink-boxes .card.block h2{font-size:28px;font-weight:300}.my-2{margin:0}.pink-boxes.dark\\:bg-background-dark:is(.dark *),.three-col.dark\\:bg-background-dark:is(.dark *),.twocol-cntr.dark\\:bg-background-dark:is(.dark *){background-color:#0c0a0f!important;z-index:-1;border-radius:15px}.pink-boxes.dark\\:bg-background-dark:is(.dark *) .card.block{background-color:transparent;border:1px solid #494949;position:relative}.three-col.dark\\:bg-background-dark:not(.dark *),.twocol-cntr.dark\\:bg-background-dark:not(.dark *){background-color:#fff!important;z-index:-1;border-radius:15px}.bg-primary{background-color:rgb(var(--gray-950)/var(--tw-bg-opacity))}.image-boxes h2{font-size:24px;font-weight:600;line-height:32px;letter-spacing:-.2px}.subtitle{text-align:center;font-size:20px;font-style:normal;font-weight:400;line-height:28px;letter-spacing:.04px;width:70%;margin:auto}.spacer{height:80px}.resource-boxes{text-align:center}.resource-boxes .dark\\:bg-background-dark:is(.dark *){background-color:#121213}.bodyContainer hr{border-color:#e3dfe2}.bodyContainer:is(.dark *) hr{border-color:#27272a}.col-lg-6{width:50%}.footer{padding-bottom:2.5rem;display:flex;background:0 0}.footer .dark\\:bg-background-dark:is(.dark *){background-color:transparent}.footer li,.footer p{font-size:14px;font-style:normal;font-weight:600;line-height:24px;letter-spacing:-.084px;margin-top:12px}.footer li a{color:#ff2ec1}.footer .updated.col-lg-6{display:flex;justify-content:flex-end}.fa-thin.fa-headphones,.fa-thin.fa-list,.fa-thin.fa-question-circle{mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/question.svg);mask-repeat:no-repeat;mask-position:center center}.fa-thin.fa-headphones,.fa-thin.fa-list{mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/headphones.svg)}.fa-thin.fa-list{mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/list.svg)}.fa-thin:is(.dark *){background-color:#fff}.footer.bg-background-light{background-color:transparent}.dark\\:text-gray-400:is(.dark *){color:#fff}#navbar-transition{display:none}.callout{border-color:rgba(255 46 193 .5);background-color:rgba(255 46 193 .3)}"}],"page":{"pagePath":"v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id","slug":"/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id","pageMetadata":{"openapi":"dropship_invoice.openapi put /v1/retailers/{retailer_id}/invoices/{id}/acknowledge/","title":"Acknowledge receipt of an invoice.","description":"As a merchant, you should include `is_acknowledged=0` as a query string parameter to get only new invoices. \u003cbr /> \u003cbr /> Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the `/shipments/?is_acknowledged=0` endpoint doesn't return processed shipments.","href":"/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id"},"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: [\"As a merchant, you should include \", _jsx(_components.code, {\n children: \"is_acknowledged=0\"\n }), \" as a query string parameter to get only new invoices. \", _jsx(\"br\", {}), \" \", _jsx(\"br\", {}), \" Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the \", _jsx(_components.code, {\n children: \"/shipments/?is_acknowledged=0\"\n }), \" endpoint doesn’t return processed shipments.\"]\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":{"openapi":"dropship_invoice.openapi put /v1/retailers/{retailer_id}/invoices/{id}/acknowledge/","title":"Acknowledge receipt of an invoice.","description":"As a merchant, you should include `is_acknowledged=0` as a query string parameter to get only new invoices. \u003cbr /> \u003cbr /> Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the `/shipments/?is_acknowledged=0` endpoint doesn't return processed shipments.","href":"/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fabric-demo/6a81ae5b5ebc4bb2/theme.js","/_mintlify/custom/fabric-demo/aebbe2ead0ce64f7/top-form.v1.js","/_mintlify/custom/fabric-demo/5b243c7a49e8f495/gtag.js"],"openApiReferenceData":{"operation":{"tags":["Invoices"],"summary":"Acknowledge receipt of an invoice.","description":"As a merchant, you should include `is_acknowledged=0` as a query string parameter to get only new invoices. \u003cbr /> \u003cbr /> Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the `/shipments/?is_acknowledged=0` endpoint doesn't return processed shipments.","operationId":"v1_retailers_invoices_acknowledge","parameters":["5d99bac3-bf64-4dd2-84db-d38e356cb82e","4c787bf6-13a6-4f7f-9270-d73b77e4d5c9"],"requestBody":"35ceb14c-2139-43b2-9973-8498f0d84e33","responses":{"200":"84743bb2-adeb-4359-9622-d2639f1881bd"},"method":"put","type":"path","servers":["208b8719-3cac-4d6f-8c2e-bfd5df078d89"],"security":["147054be-81bb-4902-ab21-6b747fcd48c6"],"path":"/v1/retailers/{retailer_id}/invoices/{id}/acknowledge/","baseUrlOptions":["https://marketplace-api.fabric.inc"],"title":"Acknowledge receipt of an invoice.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5d99bac3-bf64-4dd2-84db-d38e356cb82e":{"name":"id","in":"path","description":"The unique invoice ID. This ID is automatically generated when an invoice is created.","required":true,"schema":{"type":"integer","isRequired":true,"description":"The unique invoice ID. This ID is automatically generated when an invoice is created.","uniqueKey":"","typeLabel":"integer"},"example":77717358},"4c787bf6-13a6-4f7f-9270-d73b77e4d5c9":{"name":"retailer_id","in":"path","description":"The unique retailer ID. In the Dropship UI this is called the **Merchant ID**. To find your Merchant ID, click your merchant name in the top nav.","required":true,"schema":{"type":"number","isRequired":true,"description":"The unique retailer ID. In the Dropship UI this is called the **Merchant ID**. To find your Merchant ID, click your merchant name in the top nav.","uniqueKey":"","typeLabel":"number"},"example":1020}},"requestBody":{"content":{"application/json":{"schema":{"required":["invoice_number"],"type":"object","properties":{"invoice_number":{"description":"Invoice number","example":"RC123456","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_number","typeLabel":"string"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"retailer.code","typeLabel":"string\u003cslug>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"retailer","typeLabel":"object"},"brand":{"required":["code"],"type":"object","properties":{"code":{"description":"Vendor code, which is vendor name in lower case and underscore","example":"demo-brand","maxLength":64,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"brand.code","typeLabel":"string\u003cslug>"},"name":{"description":"Vendor name","example":"Marla Cielo","maxLength":64,"minLength":1,"type":"string","uniqueKey":"brand.name","typeLabel":"string"},"website":{"oneOf":[{"description":"URL of brand website","example":null,"maxLength":100,"type":"string","format":"uri","uniqueKey":"brand.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"URL of brand website","example":null,"maxLength":100,"type":"null","format":"uri","uniqueKey":"brand.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.website","typeLabel":"string\u003curi> | null"},"is_on_rcn":{"description":"true: is on Dropship network |false: not on Dropship network","example":false,"type":"boolean","uniqueKey":"brand.is_on_rcn","typeLabel":"boolean"},"requires_subscription":{"description":"Represents whether subscription is required","example":"enabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"brand.requires_subscription","typeLabel":"enum\u003cstring>"},"subscription_expires_at":{"oneOf":[{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"string","format":"date-time","uniqueKey":"brand.subscription_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"null","format":"date-time","uniqueKey":"brand.subscription_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.subscription_expires_at","typeLabel":"string\u003cdate-time> | null"},"grace_period_ends_at":{"oneOf":[{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"string","format":"date-time","uniqueKey":"brand.grace_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"null","format":"date-time","uniqueKey":"brand.grace_period_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.grace_period_ends_at","typeLabel":"string\u003cdate-time> | null"},"inventory_policy":{"description":"Inventory policy","example":"managed","type":"string","enum":["unmanaged","managed","use_variant_policy"],"uniqueKey":"brand.inventory_policy","typeLabel":"enum\u003cstring>"},"status":{"description":"Vendor status","example":"active","type":"string","enum":["active","pending","inactive"],"uniqueKey":"brand.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"brand","typeLabel":"object"},"currency":{"type":"object","properties":{"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency.symbol","typeLabel":"string | null"}},"uniqueKey":"currency","typeLabel":"object"},"terms_type":{"oneOf":[{"description":"Types of invoice terms","example":"Previously agreed upon","type":"string","enum":["End of Month (EOM)","No Charge","Consignment","10 Days After End of Month (10 EOM)","Cash Discount Terms Apply","Basic","Fixed Date, Late Payment Penalty Applies","Extended","Discount Not Applicable","Fixed Date","Previously agreed upon"],"uniqueKey":"terms_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Types of invoice terms","example":"Previously agreed upon","type":"null","enum":["End of Month (EOM)","No Charge","Consignment","10 Days After End of Month (10 EOM)","Cash Discount Terms Apply","Basic","Fixed Date, Late Payment Penalty Applies","Extended","Discount Not Applicable","Fixed Date","Previously agreed upon"],"uniqueKey":"terms_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_type","typeLabel":"enum\u003cstring> | null"},"terms_description":{"oneOf":[{"description":"Description of invoice terms","example":"Previously agreed upon terms will apply","type":"string","uniqueKey":"terms_description.oneOf.0","typeLabel":"string"},{"description":"Description of invoice terms","example":"Previously agreed upon terms will apply","type":"null","uniqueKey":"terms_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_description","typeLabel":"string | null"},"terms_net_days_due":{"oneOf":[{"description":"Number of days to pay invoice","example":35,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"terms_net_days_due.oneOf.0","typeLabel":"integer"},{"description":"Number of days to pay invoice","example":35,"maximum":2147483647,"minimum":-2147483648,"type":"null","uniqueKey":"terms_net_days_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_net_days_due","typeLabel":"integer | null"},"terms_date_due":{"oneOf":[{"description":"Payment expected date","example":null,"type":"string","format":"date","uniqueKey":"terms_date_due.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment expected date","example":null,"type":"null","format":"date","uniqueKey":"terms_date_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_date_due","typeLabel":"string\u003cdate> | null"},"terms_discount_percent":{"oneOf":[{"description":"Discount percentage on selected term","example":null,"type":"string","format":"decimal","uniqueKey":"terms_discount_percent.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Discount percentage on selected term","example":null,"type":"null","format":"decimal","uniqueKey":"terms_discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_discount_percent","typeLabel":"string\u003cdecimal> | null"},"order_id":{"description":"Order ID related to invoice","example":"O-654","type":"integer","uniqueKey":"order_id","typeLabel":"integer"},"customer_order_number":{"oneOf":[{"description":"Customer order number (for enduser)","example":"CO-435","maxLength":64,"type":"string","uniqueKey":"customer_order_number.oneOf.0","typeLabel":"string"},{"description":"Customer order number (for enduser)","example":"CO-435","maxLength":64,"type":"null","uniqueKey":"customer_order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_order_number","typeLabel":"string | null"},"purchase_order_number":{"oneOf":[{"description":"Purchase order number (for retailer)","example":"PO-546","maxLength":64,"type":"string","uniqueKey":"purchase_order_number.oneOf.0","typeLabel":"string"},{"description":"Purchase order number (for retailer)","example":"PO-546","maxLength":64,"type":"null","uniqueKey":"purchase_order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase_order_number","typeLabel":"string | null"},"status":{"description":"Invoice status","example":"closed","type":"string","enum":["closed","open"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"remit_to":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.country","typeLabel":"string"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"remit_to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"remit_to.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"remit_to.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"remit_to.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"remit_to.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"remit_to.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"remit_to.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"remit_to.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"remit_to.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"remit_to.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"remit_to.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"remit_to.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"remit_to.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"remit_to.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"remit_to.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"remit_to.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"remit_to","typeLabel":"object"},"ship_from":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.country","typeLabel":"string"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"ship_from.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"ship_from.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"ship_from.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"ship_from.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_from.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_from.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"ship_from.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"ship_from.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"ship_from.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"ship_from.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_from.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_from.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_from.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_from.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_from.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_from.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"ship_from","typeLabel":"object"},"sold_to":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.country","typeLabel":"string"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"sold_to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"sold_to.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"sold_to.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"sold_to.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"sold_to.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"sold_to.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"sold_to.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"sold_to.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"sold_to.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"sold_to.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"sold_to.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"sold_to.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"sold_to.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"sold_to.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"sold_to.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"sold_to.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"sold_to","typeLabel":"object"},"ship_to":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.country","typeLabel":"string"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"ship_to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"ship_to.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"ship_to.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"ship_to.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_to.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_to.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"ship_to.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"ship_to.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"ship_to.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"ship_to.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_to.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_to.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_to.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_to.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_to.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_to.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"ship_to","typeLabel":"object"},"shipping_carrier_name":{"oneOf":[{"description":"Name of shipping carrier","example":"ALZ carrier","maxLength":32,"type":"string","uniqueKey":"shipping_carrier_name.oneOf.0","typeLabel":"string"},{"description":"Name of shipping carrier","example":"ALZ carrier","maxLength":32,"type":"null","uniqueKey":"shipping_carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_carrier_name","typeLabel":"string | null"},"shipping_carrier_code":{"oneOf":[{"description":"Code of shipping carrier","example":"230F","maxLength":32,"type":"string","uniqueKey":"shipping_carrier_code.oneOf.0","typeLabel":"string"},{"description":"Code of shipping carrier","example":"230F","maxLength":32,"type":"null","uniqueKey":"shipping_carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_carrier_code","typeLabel":"string | null"},"shipping_account_number":{"oneOf":[{"description":"Shipping account number","example":"SH879","maxLength":32,"type":"string","uniqueKey":"shipping_account_number.oneOf.0","typeLabel":"string"},{"description":"Shipping account number","example":"SH879","maxLength":32,"type":"null","uniqueKey":"shipping_account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_account_number","typeLabel":"string | null"},"shipping_method_name":{"oneOf":[{"description":"Name of shipping method","example":"Next day delivery","maxLength":32,"type":"string","uniqueKey":"shipping_method_name.oneOf.0","typeLabel":"string"},{"description":"Name of shipping method","example":"Next day delivery","maxLength":32,"type":"null","uniqueKey":"shipping_method_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method_name","typeLabel":"string | null"},"shipping_method_code":{"oneOf":[{"description":"Code of shipping method","example":"ND","maxLength":32,"type":"string","uniqueKey":"shipping_method_code.oneOf.0","typeLabel":"string"},{"description":"Code of shipping method","example":"ND","maxLength":32,"type":"null","uniqueKey":"shipping_method_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method_code","typeLabel":"string | null"},"shipping_tracking_number":{"oneOf":[{"description":"Shipping tracking number","example":"1Z9999999999999988","maxLength":32,"type":"string","uniqueKey":"shipping_tracking_number.oneOf.0","typeLabel":"string"},{"description":"Shipping tracking number","example":"1Z9999999999999988","maxLength":32,"type":"null","uniqueKey":"shipping_tracking_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_tracking_number","typeLabel":"string | null"},"shipping_weight":{"oneOf":[{"description":"Shipping weight","example":"7.00","type":"string","format":"decimal","uniqueKey":"shipping_weight.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Shipping weight","example":"7.00","type":"null","format":"decimal","uniqueKey":"shipping_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_weight","typeLabel":"string\u003cdecimal> | null"},"notes":{"oneOf":[{"description":"Additional info adding to shipping","example":"Signature required","type":"string","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"description":"Additional info adding to shipping","example":"Signature required","type":"null","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"invoiced_at":{"oneOf":[{"description":"Time when the invoice was created (UTC format).","example":"2022-05-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoiced_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when the invoice was created (UTC format).","example":"2022-05-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoiced_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiced_at","typeLabel":"string\u003cdate-time> | null"},"ordered_at":{"oneOf":[{"description":"Time of order finalization (UTC format)","example":"2022-05-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"ordered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of order finalization (UTC format)","example":"2022-05-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"ordered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"ordered_at","typeLabel":"string\u003cdate-time> | null"},"shipped_at":{"oneOf":[{"description":"Time of shipping (UTC format)","example":"2022-05-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"shipped_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of shipping (UTC format)","example":"2022-05-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"shipped_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipped_at","typeLabel":"string\u003cdate-time> | null"},"acknowledged_at":{"oneOf":[{"description":"Time of retailer acknowledgement (UTC format)","example":"2022-06-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"acknowledged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of retailer acknowledgement (UTC format)","example":"2022-06-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"acknowledged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"acknowledged_at","typeLabel":"string\u003cdate-time> | null"},"paid_at":{"oneOf":[{"description":"Time of payment (UTC format)","example":"2022-06-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of payment (UTC format)","example":"2022-06-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"paid_at","typeLabel":"string\u003cdate-time> | null"},"closed_at":{"oneOf":[{"description":"Time of complete invoice payment (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"closed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of complete invoice payment (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"closed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"closed_at","typeLabel":"string\u003cdate-time> | null"},"canceled_at":{"oneOf":[{"description":"Time of order cancellation (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of order cancellation (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"canceled_at","typeLabel":"string\u003cdate-time> | null"},"allowances":{"type":"array","items":{"required":["description","price"],"type":"object","properties":{"description":{"description":"Description of allowance","example":"Sample-discount-allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"allowances.items.[INDEX].description","typeLabel":"string"},"price":{"description":"Allowance price","example":"12.10","type":"string","format":"decimal","isRequired":true,"uniqueKey":"allowances.items.[INDEX].price","typeLabel":"string\u003cdecimal>"},"adjustment_code":{"required":["adjustment_type","code","description"],"type":"object","properties":{"adjustment_type":{"description":"Adjustment type","example":"Allowance","type":"string","enum":["allowance","charge"],"isRequired":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.adjustment_type","typeLabel":"enum\u003cstring>"},"code":{"description":"Adjustment code","example":"returns_allowance","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.code","typeLabel":"string"},"description":{"description":"Description of adjustment","example":"returns_allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.description","typeLabel":"string"}},"uniqueKey":"allowances.items.[INDEX].adjustment_code","typeLabel":"object"}},"uniqueKey":"allowances.items.[INDEX]","typeLabel":"object"},"uniqueKey":"allowances","typeLabel":"object[]"},"charges":{"type":"array","items":{"required":["description","price"],"type":"object","properties":{"description":{"description":"Invoice description","example":"Sample invoice and its description","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].description","typeLabel":"string"},"price":{"description":"Invoice price","example":"23.45","type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].price","typeLabel":"string"},"adjustment_code":{"required":["adjustment_type","code","description"],"type":"object","properties":{"adjustment_type":{"description":"Adjustment type","example":"Allowance","type":"string","enum":["allowance","charge"],"isRequired":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.adjustment_type","typeLabel":"enum\u003cstring>"},"code":{"description":"Adjustment code","example":"returns_allowance","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.code","typeLabel":"string"},"description":{"description":"Description of adjustment","example":"returns_allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.description","typeLabel":"string"}},"uniqueKey":"charges.items.[INDEX].adjustment_code","typeLabel":"object"}},"uniqueKey":"charges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"charges","typeLabel":"object[]"},"net_amount":{"oneOf":[{"description":"Total invoice amount (excluding taxes)","example":"12.89","type":"string","format":"decimal","uniqueKey":"net_amount.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Total invoice amount (excluding taxes)","example":"12.89","type":"null","format":"decimal","uniqueKey":"net_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"net_amount","typeLabel":"string\u003cdecimal> | null"},"due_amount":{"oneOf":[{"description":"Pending amount","example":"2.89","type":"string","format":"decimal","uniqueKey":"due_amount.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Pending amount","example":"2.89","type":"null","format":"decimal","uniqueKey":"due_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"due_amount","typeLabel":"string\u003cdecimal> | null"},"expected_due_amount":{"oneOf":[{"description":"Expected due amount (excluding *allowances* and *charges*)","example":"2.89","type":"string","format":"decimal","uniqueKey":"expected_due_amount.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Expected due amount (excluding *allowances* and *charges*)","example":"2.89","type":"null","format":"decimal","uniqueKey":"expected_due_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"expected_due_amount","typeLabel":"string\u003cdecimal> | null"},"subtotal":{"oneOf":[{"description":"Sub-total","example":"10.89","type":"string","format":"decimal","uniqueKey":"subtotal.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Sub-total","example":"10.89","type":"null","format":"decimal","uniqueKey":"subtotal.oneOf.1","typeLabel":"null"}],"uniqueKey":"subtotal","typeLabel":"string\u003cdecimal> | null"},"tax":{"oneOf":[{"description":"Total tax on the invoice","example":"2.00","type":"string","format":"decimal","uniqueKey":"tax.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Total tax on the invoice","example":"2.00","type":"null","format":"decimal","uniqueKey":"tax.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax","typeLabel":"string\u003cdecimal> | null"},"invoice_acceptance":{"type":"object","properties":{"accepted_by":{"type":"object","properties":{"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.accepted_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.accepted_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.accepted_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.accepted_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.accepted_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.accepted_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"invoice_acceptance.accepted_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"invoice_acceptance.accepted_by.type","typeLabel":"enum\u003cstring>"}},"description":"Vendor acceptance","uniqueKey":"invoice_acceptance.accepted_by","typeLabel":"object"},"rejected_by":{"type":"object","properties":{"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.rejected_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.rejected_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.rejected_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.rejected_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.rejected_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.rejected_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"invoice_acceptance.rejected_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"invoice_acceptance.rejected_by.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_acceptance.rejected_by","typeLabel":"object"},"reject_reason":{"oneOf":[{"description":"Reason for invoice rejection","example":"Incorrect","maxLength":128,"type":"string","uniqueKey":"invoice_acceptance.reject_reason.oneOf.0","typeLabel":"string"},{"description":"Reason for invoice rejection","example":"Incorrect","maxLength":128,"type":"null","uniqueKey":"invoice_acceptance.reject_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.reject_reason","typeLabel":"string | null"},"accepted_at":{"oneOf":[{"description":"Time when the invoice was accepted (UTC format).","example":"2022-08-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_acceptance.accepted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when the invoice was accepted (UTC format).","example":"2022-08-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_acceptance.accepted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_at","typeLabel":"string\u003cdate-time> | null"},"rejected_at":{"oneOf":[{"description":"Time when the invoice was accepted (UTC format).","example":null,"type":"string","format":"date-time","uniqueKey":"invoice_acceptance.rejected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when the invoice was accepted (UTC format).","example":null,"type":"null","format":"date-time","uniqueKey":"invoice_acceptance.rejected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"invoice_acceptance","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"invoice_number":"RC123456","currency":{"name":"United States Dollar","symbol":"$"},"terms_type":"Previously agreed upon","terms_description":"Previously agreed upon terms will apply","terms_net_days_due":35,"terms_date_due":null,"terms_discount_percent":null,"order_id":"O-654","customer_order_number":"CO-435","purchase_order_number":"PO-546","status":"closed","shipping_carrier_name":"ALZ carrier","shipping_carrier_code":"230F","shipping_account_number":"SH879","shipping_method_name":"Next day delivery","shipping_method_code":"ND","shipping_tracking_number":"1Z9999999999999988","shipping_weight":"7.00","notes":"Signature required","invoiced_at":"2022-05-10T15:24:56Z","ordered_at":"2022-05-10T15:24:56Z","shipped_at":"2022-05-10T15:24:56Z","acknowledged_at":"2022-06-10T15:24:56Z","paid_at":"2022-06-10T15:24:56Z","closed_at":null,"canceled_at":null,"allowances":[{"description":"Sample-discount-allowance","price":"12.10"}],"charges":[{"description":"Sample invoice and its description","price":"23.45"}],"net_amount":"12.89","due_amount":"2.89","expected_due_amount":"2.89","subtotal":"10.89","tax":"2.00","invoice_acceptance":{"accepted_by":{"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard"},"rejected_by":{"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard"},"reject_reason":"Incorrect","accepted_at":"2022-08-10T15:24:56Z","rejected_at":null}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"84743bb2-adeb-4359-9622-d2639f1881bd":{"description":"OK","content":{"application/json":{"schema":{"required":["invoice_number"],"type":"object","properties":{"invoice_number":{"description":"Invoice number","example":"RC123456","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_number","typeLabel":"string"},"id":{"description":"Invoice ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"id","typeLabel":"integer"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"retailer","typeLabel":"object"},"brand":{"required":["code"],"type":"object","properties":{"code":{"description":"Vendor code, which is vendor name in lower case and underscore","example":"demo-brand","maxLength":64,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"brand.code","typeLabel":"string\u003cslug>"},"id":{"description":"Vendor (brand) ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"brand.id","typeLabel":"integer"},"name":{"description":"Vendor name","example":"Marla Cielo","maxLength":64,"minLength":1,"type":"string","uniqueKey":"brand.name","typeLabel":"string"},"joined_at":{"description":"Time when vendor joined Dropship (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"brand.joined_at","typeLabel":"string\u003cdate-time>"},"logo_url":{"description":"URL of the brand logo","example":"https://images.revcascade.com/retailers/defaults/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of the cover image","example":"https://images.revcascade.com/retailers/defaults/cover.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of the profile image","example":"https://images.revcascade.com/retailers/defaults/profile-tile.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.profile_tile_url","typeLabel":"string\u003curi>"},"website":{"oneOf":[{"description":"URL of brand website","example":null,"maxLength":100,"type":"string","format":"uri","uniqueKey":"brand.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"URL of brand website","example":null,"maxLength":100,"type":"null","format":"uri","uniqueKey":"brand.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.website","typeLabel":"string\u003curi> | null"},"is_onboarded":{"description":"true: Vendor is onboarded |false: Vendor is not onboarded","example":false,"type":"boolean","readOnly":true,"uniqueKey":"brand.is_onboarded","typeLabel":"boolean"},"is_on_rcn":{"description":"true: is on Dropship network |false: not on Dropship network","example":false,"type":"boolean","uniqueKey":"brand.is_on_rcn","typeLabel":"boolean"},"requires_subscription":{"description":"Represents whether subscription is required","example":"enabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"brand.requires_subscription","typeLabel":"enum\u003cstring>"},"subscription_expires_at":{"oneOf":[{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"string","format":"date-time","uniqueKey":"brand.subscription_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"null","format":"date-time","uniqueKey":"brand.subscription_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.subscription_expires_at","typeLabel":"string\u003cdate-time> | null"},"grace_period_ends_at":{"oneOf":[{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"string","format":"date-time","uniqueKey":"brand.grace_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"null","format":"date-time","uniqueKey":"brand.grace_period_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.grace_period_ends_at","typeLabel":"string\u003cdate-time> | null"},"subscription_is_expired":{"description":"true: subscription is expired | false: subscription is active","example":false,"type":"boolean","readOnly":true,"uniqueKey":"brand.subscription_is_expired","typeLabel":"boolean"},"subscription_is_on_grace_period":{"description":"true: subscription is on grace period | false: subscription is not on grace period","example":false,"type":"boolean","readOnly":true,"uniqueKey":"brand.subscription_is_on_grace_period","typeLabel":"boolean"},"subscription_is_delinquent":{"description":"true: subscription is overdue | false: subscription is paid","example":false,"type":"boolean","readOnly":true,"uniqueKey":"brand.subscription_is_delinquent","typeLabel":"boolean"},"inventory_policy":{"description":"Inventory policy","example":"managed","type":"string","enum":["unmanaged","managed","use_variant_policy"],"uniqueKey":"brand.inventory_policy","typeLabel":"enum\u003cstring>"},"status":{"description":"Vendor status","example":"active","type":"string","enum":["active","pending","inactive"],"uniqueKey":"brand.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"brand","typeLabel":"object"},"connection_id":{"description":"Connection ID","example":2,"type":"string","readOnly":true,"uniqueKey":"connection_id","typeLabel":"string"},"currency":{"type":"object","properties":{"id":{"description":"Currency ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"currency.id","typeLabel":"integer"},"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency.symbol","typeLabel":"string | null"},"unit":{"description":"Currency unit","example":"USD","type":"string","readOnly":true,"uniqueKey":"currency.unit","typeLabel":"string"}},"uniqueKey":"currency","typeLabel":"object"},"terms_type":{"oneOf":[{"description":"Types of invoice terms","example":"Previously agreed upon","type":"string","enum":["End of Month (EOM)","No Charge","Consignment","10 Days After End of Month (10 EOM)","Cash Discount Terms Apply","Basic","Fixed Date, Late Payment Penalty Applies","Extended","Discount Not Applicable","Fixed Date","Previously agreed upon"],"uniqueKey":"terms_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Types of invoice terms","example":"Previously agreed upon","type":"null","enum":["End of Month (EOM)","No Charge","Consignment","10 Days After End of Month (10 EOM)","Cash Discount Terms Apply","Basic","Fixed Date, Late Payment Penalty Applies","Extended","Discount Not Applicable","Fixed Date","Previously agreed upon"],"uniqueKey":"terms_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_type","typeLabel":"enum\u003cstring> | null"},"terms_description":{"oneOf":[{"description":"Description of invoice terms","example":"Previously agreed upon terms will apply","type":"string","uniqueKey":"terms_description.oneOf.0","typeLabel":"string"},{"description":"Description of invoice terms","example":"Previously agreed upon terms will apply","type":"null","uniqueKey":"terms_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_description","typeLabel":"string | null"},"terms_net_days_due":{"oneOf":[{"description":"Number of days to pay invoice","example":35,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"terms_net_days_due.oneOf.0","typeLabel":"integer"},{"description":"Number of days to pay invoice","example":35,"maximum":2147483647,"minimum":-2147483648,"type":"null","uniqueKey":"terms_net_days_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_net_days_due","typeLabel":"integer | null"},"terms_date_due":{"oneOf":[{"description":"Payment expected date","example":null,"type":"string","format":"date","uniqueKey":"terms_date_due.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment expected date","example":null,"type":"null","format":"date","uniqueKey":"terms_date_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_date_due","typeLabel":"string\u003cdate> | null"},"terms_discount_percent":{"oneOf":[{"description":"Discount percentage on selected term","example":null,"type":"string","format":"decimal","uniqueKey":"terms_discount_percent.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Discount percentage on selected term","example":null,"type":"null","format":"decimal","uniqueKey":"terms_discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_discount_percent","typeLabel":"string\u003cdecimal> | null"},"order_id":{"description":"Order ID related to invoice","example":"O-654","type":"integer","uniqueKey":"order_id","typeLabel":"integer"},"customer_order_number":{"oneOf":[{"description":"Customer order number (for enduser)","example":"CO-435","maxLength":64,"type":"string","uniqueKey":"customer_order_number.oneOf.0","typeLabel":"string"},{"description":"Customer order number (for enduser)","example":"CO-435","maxLength":64,"type":"null","uniqueKey":"customer_order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_order_number","typeLabel":"string | null"},"purchase_order_number":{"oneOf":[{"description":"Purchase order number (for retailer)","example":"PO-546","maxLength":64,"type":"string","uniqueKey":"purchase_order_number.oneOf.0","typeLabel":"string"},{"description":"Purchase order number (for retailer)","example":"PO-546","maxLength":64,"type":"null","uniqueKey":"purchase_order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase_order_number","typeLabel":"string | null"},"status":{"description":"Invoice status","example":"closed","type":"string","enum":["closed","open"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"remit_to":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"remit_to.country","typeLabel":"string"},"id":{"description":"Address ID","example":10,"type":"integer","readOnly":true,"uniqueKey":"remit_to.id","typeLabel":"integer"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"remit_to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"remit_to.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"remit_to.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"remit_to.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"remit_to.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"remit_to.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"remit_to.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"remit_to.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"remit_to.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"remit_to.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"remit_to.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"remit_to.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"remit_to.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"remit_to.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"remit_to.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"remit_to.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"remit_to.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"remit_to","typeLabel":"object"},"ship_from":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_from.country","typeLabel":"string"},"id":{"description":"Address ID","example":10,"type":"integer","readOnly":true,"uniqueKey":"ship_from.id","typeLabel":"integer"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"ship_from.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"ship_from.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"ship_from.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"ship_from.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_from.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_from.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"ship_from.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"ship_from.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"ship_from.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"ship_from.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_from.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_from.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_from.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_from.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_from.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_from.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_from.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"ship_from","typeLabel":"object"},"sold_to":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"sold_to.country","typeLabel":"string"},"id":{"description":"Address ID","example":10,"type":"integer","readOnly":true,"uniqueKey":"sold_to.id","typeLabel":"integer"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"sold_to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"sold_to.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"sold_to.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"sold_to.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"sold_to.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"sold_to.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"sold_to.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"sold_to.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"sold_to.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"sold_to.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"sold_to.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"sold_to.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"sold_to.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"sold_to.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"sold_to.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"sold_to.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"sold_to.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"sold_to","typeLabel":"object"},"ship_to":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"ship_to.country","typeLabel":"string"},"id":{"description":"Address ID","example":10,"type":"integer","readOnly":true,"uniqueKey":"ship_to.id","typeLabel":"integer"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"ship_to.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"ship_to.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"ship_to.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"ship_to.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_to.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_to.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"ship_to.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"ship_to.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"ship_to.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"ship_to.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_to.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_to.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"ship_to.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"ship_to.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"ship_to.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"ship_to.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"ship_to.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"ship_to","typeLabel":"object"},"shipping_carrier_name":{"oneOf":[{"description":"Name of shipping carrier","example":"ALZ carrier","maxLength":32,"type":"string","uniqueKey":"shipping_carrier_name.oneOf.0","typeLabel":"string"},{"description":"Name of shipping carrier","example":"ALZ carrier","maxLength":32,"type":"null","uniqueKey":"shipping_carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_carrier_name","typeLabel":"string | null"},"shipping_carrier_code":{"oneOf":[{"description":"Code of shipping carrier","example":"230F","maxLength":32,"type":"string","uniqueKey":"shipping_carrier_code.oneOf.0","typeLabel":"string"},{"description":"Code of shipping carrier","example":"230F","maxLength":32,"type":"null","uniqueKey":"shipping_carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_carrier_code","typeLabel":"string | null"},"shipping_account_number":{"oneOf":[{"description":"Shipping account number","example":"SH879","maxLength":32,"type":"string","uniqueKey":"shipping_account_number.oneOf.0","typeLabel":"string"},{"description":"Shipping account number","example":"SH879","maxLength":32,"type":"null","uniqueKey":"shipping_account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_account_number","typeLabel":"string | null"},"shipping_method_name":{"oneOf":[{"description":"Name of shipping method","example":"Next day delivery","maxLength":32,"type":"string","uniqueKey":"shipping_method_name.oneOf.0","typeLabel":"string"},{"description":"Name of shipping method","example":"Next day delivery","maxLength":32,"type":"null","uniqueKey":"shipping_method_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method_name","typeLabel":"string | null"},"shipping_method_code":{"oneOf":[{"description":"Code of shipping method","example":"ND","maxLength":32,"type":"string","uniqueKey":"shipping_method_code.oneOf.0","typeLabel":"string"},{"description":"Code of shipping method","example":"ND","maxLength":32,"type":"null","uniqueKey":"shipping_method_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method_code","typeLabel":"string | null"},"shipping_tracking_number":{"oneOf":[{"description":"Shipping tracking number","example":"1Z9999999999999988","maxLength":32,"type":"string","uniqueKey":"shipping_tracking_number.oneOf.0","typeLabel":"string"},{"description":"Shipping tracking number","example":"1Z9999999999999988","maxLength":32,"type":"null","uniqueKey":"shipping_tracking_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_tracking_number","typeLabel":"string | null"},"shipping_weight":{"oneOf":[{"description":"Shipping weight","example":"7.00","type":"string","format":"decimal","uniqueKey":"shipping_weight.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Shipping weight","example":"7.00","type":"null","format":"decimal","uniqueKey":"shipping_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_weight","typeLabel":"string\u003cdecimal> | null"},"notes":{"oneOf":[{"description":"Additional info adding to shipping","example":"Signature required","type":"string","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"description":"Additional info adding to shipping","example":"Signature required","type":"null","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"invoiced_at":{"oneOf":[{"description":"Time when the invoice was created (UTC format).","example":"2022-05-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoiced_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when the invoice was created (UTC format).","example":"2022-05-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoiced_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiced_at","typeLabel":"string\u003cdate-time> | null"},"ordered_at":{"oneOf":[{"description":"Time of order finalization (UTC format)","example":"2022-05-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"ordered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of order finalization (UTC format)","example":"2022-05-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"ordered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"ordered_at","typeLabel":"string\u003cdate-time> | null"},"shipped_at":{"oneOf":[{"description":"Time of shipping (UTC format)","example":"2022-05-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"shipped_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of shipping (UTC format)","example":"2022-05-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"shipped_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipped_at","typeLabel":"string\u003cdate-time> | null"},"acknowledged_at":{"oneOf":[{"description":"Time of retailer acknowledgement (UTC format)","example":"2022-06-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"acknowledged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of retailer acknowledgement (UTC format)","example":"2022-06-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"acknowledged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"acknowledged_at","typeLabel":"string\u003cdate-time> | null"},"paid_at":{"oneOf":[{"description":"Time of payment (UTC format)","example":"2022-06-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"paid_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of payment (UTC format)","example":"2022-06-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"paid_at","typeLabel":"string\u003cdate-time> | null"},"closed_at":{"oneOf":[{"description":"Time of complete invoice payment (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"closed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of complete invoice payment (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"closed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"closed_at","typeLabel":"string\u003cdate-time> | null"},"canceled_at":{"oneOf":[{"description":"Time of order cancellation (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of order cancellation (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"canceled_at","typeLabel":"string\u003cdate-time> | null"},"allowances":{"type":"array","items":{"required":["description","price"],"type":"object","properties":{"description":{"description":"Description of allowance","example":"Sample-discount-allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"allowances.items.[INDEX].description","typeLabel":"string"},"price":{"description":"Allowance price","example":"12.10","type":"string","format":"decimal","isRequired":true,"uniqueKey":"allowances.items.[INDEX].price","typeLabel":"string\u003cdecimal>"},"id":{"description":"Allowance ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"allowances.items.[INDEX].id","typeLabel":"integer"},"adjustment_code":{"required":["adjustment_type","code","description"],"type":"object","properties":{"adjustment_type":{"description":"Adjustment type","example":"Allowance","type":"string","enum":["allowance","charge"],"isRequired":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.adjustment_type","typeLabel":"enum\u003cstring>"},"code":{"description":"Adjustment code","example":"returns_allowance","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.code","typeLabel":"string"},"description":{"description":"Description of adjustment","example":"returns_allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.description","typeLabel":"string"},"id":{"description":"Adjustment ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"allowances.items.[INDEX].adjustment_code.id","typeLabel":"integer"}},"uniqueKey":"allowances.items.[INDEX].adjustment_code","typeLabel":"object"}},"uniqueKey":"allowances.items.[INDEX]","typeLabel":"object"},"uniqueKey":"allowances","typeLabel":"object[]"},"charges":{"type":"array","items":{"required":["description","price"],"type":"object","properties":{"description":{"description":"Invoice description","example":"Sample invoice and its description","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].description","typeLabel":"string"},"price":{"description":"Invoice price","example":"23.45","type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].price","typeLabel":"string"},"id":{"description":"Invoice ID","example":654,"type":"integer","readOnly":true,"uniqueKey":"charges.items.[INDEX].id","typeLabel":"integer"},"adjustment_code":{"required":["adjustment_type","code","description"],"type":"object","properties":{"adjustment_type":{"description":"Adjustment type","example":"Allowance","type":"string","enum":["allowance","charge"],"isRequired":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.adjustment_type","typeLabel":"enum\u003cstring>"},"code":{"description":"Adjustment code","example":"returns_allowance","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.code","typeLabel":"string"},"description":{"description":"Description of adjustment","example":"returns_allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.description","typeLabel":"string"},"id":{"description":"Adjustment ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"charges.items.[INDEX].adjustment_code.id","typeLabel":"integer"}},"uniqueKey":"charges.items.[INDEX].adjustment_code","typeLabel":"object"}},"uniqueKey":"charges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"charges","typeLabel":"object[]"},"invoice_lines":{"type":"array","readOnly":true,"items":{"required":["price","quantity"],"type":"object","properties":{"quantity":{"description":"Product quantity","example":45,"maximum":2147483647,"minimum":-2147483648,"type":"integer","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].quantity","typeLabel":"integer"},"price":{"description":"Discounted price","example":"12.00","type":"string","format":"decimal","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].price","typeLabel":"string\u003cdecimal>"},"id":{"description":"Invoice line ID","example":765,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].id","typeLabel":"integer"},"variant":{"type":"object","properties":{"id":{"description":"Variant ID","example":100024,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.id","typeLabel":"integer"},"name":{"oneOf":[{"description":"Variant Name","example":"T-Shirt, Blue, L","maxLength":200,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.name.oneOf.0","typeLabel":"string"},{"description":"Variant Name","example":"T-Shirt, Blue, L","maxLength":200,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.name","typeLabel":"string | null"},"brand":{"required":["code"],"type":"object","properties":{"code":{"description":"Vendor code, which is vendor name in lower case and underscore","example":"demo-brand","maxLength":64,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.code","typeLabel":"string\u003cslug>"},"id":{"description":"Vendor (brand) ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.id","typeLabel":"integer"},"name":{"description":"Vendor name","example":"Marla Cielo","maxLength":64,"minLength":1,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.name","typeLabel":"string"},"joined_at":{"description":"Time when vendor joined Dropship (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.joined_at","typeLabel":"string\u003cdate-time>"},"logo_url":{"description":"URL of the brand logo","example":"https://images.revcascade.com/retailers/defaults/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of the cover image","example":"https://images.revcascade.com/retailers/defaults/cover.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of the profile image","example":"https://images.revcascade.com/retailers/defaults/profile-tile.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.profile_tile_url","typeLabel":"string\u003curi>"},"website":{"oneOf":[{"description":"URL of brand website","example":null,"maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"URL of brand website","example":null,"maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.website","typeLabel":"string\u003curi> | null"},"is_onboarded":{"description":"true: Vendor is onboarded |false: Vendor is not onboarded","example":false,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.is_onboarded","typeLabel":"boolean"},"is_on_rcn":{"description":"true: is on Dropship network |false: not on Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.is_on_rcn","typeLabel":"boolean"},"requires_subscription":{"description":"Represents whether subscription is required","example":"enabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.requires_subscription","typeLabel":"enum\u003cstring>"},"subscription_expires_at":{"oneOf":[{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.subscription_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.subscription_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.subscription_expires_at","typeLabel":"string\u003cdate-time> | null"},"grace_period_ends_at":{"oneOf":[{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.grace_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.brand.grace_period_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.grace_period_ends_at","typeLabel":"string\u003cdate-time> | null"},"subscription_is_expired":{"description":"true: subscription is expired | false: subscription is active","example":false,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.subscription_is_expired","typeLabel":"boolean"},"subscription_is_on_grace_period":{"description":"true: subscription is on grace period | false: subscription is not on grace period","example":false,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.subscription_is_on_grace_period","typeLabel":"boolean"},"subscription_is_delinquent":{"description":"true: subscription is overdue | false: subscription is paid","example":false,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.subscription_is_delinquent","typeLabel":"boolean"},"inventory_policy":{"description":"Inventory policy","example":"managed","type":"string","enum":["unmanaged","managed","use_variant_policy"],"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.inventory_policy","typeLabel":"enum\u003cstring>"},"status":{"description":"Vendor status","example":"active","type":"string","enum":["active","pending","inactive"],"uniqueKey":"invoice_lines.items.[INDEX].variant.brand.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.brand","typeLabel":"object"},"brand_identifier":{"description":"Unique SKU assigned by the Brand","example":"1000-BL-L","minLength":1,"type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.brand_identifier","typeLabel":"string"},"identifier":{"oneOf":[{"description":"Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.","example":"5000001","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.identifier.oneOf.0","typeLabel":"string"},{"description":"Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.","example":"5000001","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.identifier","typeLabel":"string | null"},"upc":{"description":"UPC or other GTIN","example":9119119111,"maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.upc","typeLabel":"string"},"cartons":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Carton ID","example":48,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].id","typeLabel":"integer"},"number":{"description":"Carton number","example":1,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].number","typeLabel":"integer"},"length":{"oneOf":[{"description":"Carton length","example":"1","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].length.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Carton length","example":"1","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].length.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].length","typeLabel":"string\u003cdecimal> | null"},"length_unit":{"description":"Unit of length","example":"1","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].length_unit","typeLabel":"string"},"width":{"oneOf":[{"description":"Carton width","example":"1","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].width.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Carton width","example":"1","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].width","typeLabel":"string\u003cdecimal> | null"},"width_unit":{"description":"Unit of width","example":"meter","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].width_unit","typeLabel":"string"},"height":{"oneOf":[{"description":"Carton height","example":"1","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].height.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Carton height","example":"1","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].height","typeLabel":"string\u003cdecimal> | null"},"height_unit":{"description":"Unit of height","example":"meter","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].height_unit","typeLabel":"string"},"weight":{"oneOf":[{"description":"Carton weight","example":"15","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].weight.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Carton weight","example":"15","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].weight","typeLabel":"string\u003cdecimal> | null"},"weight_unit":{"description":"Unit of weight","example":"KG","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].weight_unit","typeLabel":"string"},"package_girth_inches":{"description":"Girth of the package, in inches","example":"1","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].package_girth_inches","typeLabel":"string"},"package_size_inches":{"description":"Size of the package, in inches","example":"1","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX].package_size_inches","typeLabel":"string"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.cartons","typeLabel":"object[]"},"color":{"oneOf":[{"description":"Color of the item (from attributes.color)","example":"Red","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.color.oneOf.0","typeLabel":"string"},{"description":"Color of the item (from attributes.color)","example":"Red","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.color.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.color","typeLabel":"string | null"},"style":{"oneOf":[{"description":"Style of the item (will be the same value as attributes.style)","example":"Print","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.style.oneOf.0","typeLabel":"string"},{"description":"Style of the item (will be the same value as attributes.style)","example":"Print","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.style","typeLabel":"string | null"},"size":{"oneOf":[{"description":"Size of the item (will be the same value as attributes.size)","example":"Large","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.size.oneOf.0","typeLabel":"string"},{"description":"Size of the item (will be the same value as attributes.size)","example":"Large","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.size.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.size","typeLabel":"string | null"},"media":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Variant ID","example":249,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].id","typeLabel":"integer"},"width":{"oneOf":[{"description":"Width of variant image","example":100,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].width.oneOf.0","typeLabel":"integer"},{"description":"Width of variant image","example":100,"maximum":2147483647,"minimum":-2147483648,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].width","typeLabel":"integer | null"},"height":{"oneOf":[{"description":"Height of variant image","example":100,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].height.oneOf.0","typeLabel":"integer"},{"description":"Height of variant image","example":100,"maximum":2147483647,"minimum":-2147483648,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].height","typeLabel":"integer | null"},"media":{"description":"Variant images","example":"default","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].media","typeLabel":"string"},"priority":{"description":"Order in which the vendor prefers the images to be shown image 1 is shown first.","example":1,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].priority","typeLabel":"integer"},"url":{"description":"URL of variant image","example":"https://cdn.example.com/media/default/original","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].url","typeLabel":"string"},"updated_at":{"description":"Time of variant image update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"created_at":{"description":"Time of variant image creation (UTC format)","example":"2022-08-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.media.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.media","typeLabel":"object[]"},"attributes":{"type":"array","readOnly":true,"items":{"required":["code","name","type"],"type":"object","properties":{"code":{"description":"Attribute code","example":"size","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].code","typeLabel":"string"},"name":{"description":"Attribute name","example":"Size","maxLength":200,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Attribute type","example":"money","type":"string","enum":["boolean","date","list","media","money","number","percent","string","text","url"],"isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"description":"Attribute ID","example":44,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].id","typeLabel":"integer"},"editable_by":{"oneOf":[{"description":"User permission to edit attribute","example":"brand","type":"string","enum":["retailer","brand","any","none"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].editable_by.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"User permission to edit attribute","example":"brand","type":"null","enum":["retailer","brand","any","none"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].editable_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].editable_by","typeLabel":"enum\u003cstring> | null"},"grouping":{"oneOf":[{"description":"Criteria to group attribute","example":"general","type":"string","enum":["description","general","images","inventory","misc","retailer","shipping","identifiers","pricing"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].grouping.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Criteria to group attribute","example":"general","type":"null","enum":["description","general","images","inventory","misc","retailer","shipping","identifiers","pricing"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].grouping.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].grouping","typeLabel":"enum\u003cstring> | null"},"description":{"oneOf":[{"description":"Attribute description","example":"demo product description","type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Attribute description","example":"demo product description","type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].description","typeLabel":"string | null"},"units":{"oneOf":[{"description":"Unit of the selected attribute **type**. If the attribute type is money, the unit is USD.","example":"USD","maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].units.oneOf.0","typeLabel":"string"},{"description":"Unit of the selected attribute **type**. If the attribute type is money, the unit is USD.","example":"USD","maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].units.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].units","typeLabel":"string | null"},"values":{"type":"object","properties":{"id":{"description":"Attribute value ID","type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.id","typeLabel":"integer"},"value":{"description":"Attribute value","type":"string","x-nullable":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.value","typeLabel":"string"},"unit":{"type":"object","properties":{"id":{"description":"Unit ID","example":677,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.id","typeLabel":"integer"},"name":{"description":"Unit name","example":"Sample unit","minLength":1,"type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.name","typeLabel":"string"},"standard_unit":{"description":"Standard unit","minLength":1,"type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.standard_unit","typeLabel":"string"},"type":{"description":"Unit type","example":"cost","type":"string","readOnly":true,"enum":["area","distance","energy","speed","temperature","time","volume","weight","cost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.type","typeLabel":"enum\u003cstring>"},"system":{"oneOf":[{"description":"Unit system","example":"metric","type":"string","enum":["metric","imperial"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.system.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Unit system","example":"metric","type":"null","enum":["metric","imperial"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.system.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.system","typeLabel":"enum\u003cstring> | null"},"symbol":{"oneOf":[{"description":"Unit symbol","example":"USD","maxLength":5,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.symbol.oneOf.0","typeLabel":"string"},{"description":"Unit symbol","example":"USD","maxLength":5,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit.symbol","typeLabel":"string | null"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.unit","typeLabel":"object"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.retailer","typeLabel":"object"},"updated_at":{"description":"Time of update","type":"string","format":"date-time","x-nullable":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.updated_at","typeLabel":"string\u003cdate-time>"},"created_at":{"description":"Time of creation","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values.created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX].values","typeLabel":"object"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.attributes","typeLabel":"object[]"},"ruleset_variants":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"ID of ruleset variant","example":1232,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants.items.[INDEX].id","typeLabel":"integer"},"status":{"description":"Status of ruleset variant","example":"processing","type":"string","enum":["processing","passed","failed"],"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"results":{"description":"Response","type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants.items.[INDEX].results","typeLabel":"string"},"created_at":{"description":"Time of creation (UTC format)","example":"2022-08-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variants","typeLabel":"object[]"},"ruleset_variant_summary":{"description":"Number of items that are passed and failed in rule validation.","example":"21","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.ruleset_variant_summary","typeLabel":"string"},"active_permit":{"type":"object","properties":{"id":{"description":"Permit ID","example":10104,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.id","typeLabel":"integer"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer","typeLabel":"object"},"retailer_price":{"oneOf":[{"description":"Retailer price of the variant","example":"12.99","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer_price.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Retailer price of the variant","example":"12.99","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer_price","typeLabel":"string\u003cdecimal> | null"},"retailer_cost":{"oneOf":[{"description":"Retailer cost of variant","example":"8.99","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer_cost.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Retailer cost of variant","example":"8.99","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer_cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.retailer_cost","typeLabel":"string\u003cdecimal> | null"},"pricing":{"type":"object","properties":{},"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.pricing","typeLabel":"object"},"attributes":{"type":"object","properties":{},"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.attributes","typeLabel":"object"},"start_at":{"oneOf":[{"description":"Time of permit start (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of permit start (UTC format)","example":"2021-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.start_at","typeLabel":"string\u003cdate-time> | null"},"end_at":{"oneOf":[{"description":"Time of permit end (UTC format)","example":"2024-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.end_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of permit end (UTC format)","example":"2024-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.end_at","typeLabel":"string\u003cdate-time> | null"},"is_in_effect":{"description":"true: permit is in effect | false: permit is not in effect","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.is_in_effect","typeLabel":"boolean"},"revoked_at":{"oneOf":[{"description":"Time when permit got revoked (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.revoked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when permit got revoked (UTC format)","example":"2022-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.revoked_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.revoked_at","typeLabel":"string\u003cdate-time> | null"},"is_acknowledged":{"description":"true: permit is acknowledged | false: permit is not acknowledged","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.is_acknowledged","typeLabel":"boolean"},"acknowledged_at":{"oneOf":[{"description":"Time of acknowledgement (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.acknowledged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of acknowledgement (UTC format)","example":"2022-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.acknowledged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit.acknowledged_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.active_permit","typeLabel":"object"},"permits":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Permit ID","example":10104,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].id","typeLabel":"integer"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer","typeLabel":"object"},"retailer_price":{"oneOf":[{"description":"Retailer price of the variant","example":"12.99","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer_price.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Retailer price of the variant","example":"12.99","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer_price","typeLabel":"string\u003cdecimal> | null"},"retailer_cost":{"oneOf":[{"description":"Retailer cost of variant","example":"8.99","type":"string","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer_cost.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Retailer cost of variant","example":"8.99","type":"null","format":"decimal","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer_cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].retailer_cost","typeLabel":"string\u003cdecimal> | null"},"pricing":{"type":"object","properties":{},"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].pricing","typeLabel":"object"},"attributes":{"type":"object","properties":{},"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].attributes","typeLabel":"object"},"start_at":{"oneOf":[{"description":"Time of permit start (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of permit start (UTC format)","example":"2021-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].start_at","typeLabel":"string\u003cdate-time> | null"},"end_at":{"oneOf":[{"description":"Time of permit end (UTC format)","example":"2024-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].end_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of permit end (UTC format)","example":"2024-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].end_at","typeLabel":"string\u003cdate-time> | null"},"is_in_effect":{"description":"true: permit is in effect | false: permit is not in effect","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].is_in_effect","typeLabel":"boolean"},"revoked_at":{"oneOf":[{"description":"Time when permit got revoked (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].revoked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when permit got revoked (UTC format)","example":"2022-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].revoked_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].revoked_at","typeLabel":"string\u003cdate-time> | null"},"is_acknowledged":{"description":"true: permit is acknowledged | false: permit is not acknowledged","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].is_acknowledged","typeLabel":"boolean"},"acknowledged_at":{"oneOf":[{"description":"Time of acknowledgement (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].acknowledged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of acknowledgement (UTC format)","example":"2022-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].acknowledged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX].acknowledged_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.permits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.permits","typeLabel":"object[]"},"is_compatible":{"description":"true: variant meets requirement | false: variant doesn not meet requirement","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.is_compatible","typeLabel":"boolean"},"proposal_variant":{"type":"object","properties":{"id":{"description":"Proposal variant ID","example":3456,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.id","typeLabel":"integer"},"pricing":{"description":"Pricing of variant","example":"12.00","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.pricing","typeLabel":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Attribute value ID","type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].id","typeLabel":"integer"},"value":{"description":"Attribute value","type":"string","x-nullable":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].value","typeLabel":"string"},"unit":{"type":"object","properties":{"id":{"description":"Unit ID","example":677,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.id","typeLabel":"integer"},"name":{"description":"Unit name","example":"Sample unit","minLength":1,"type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.name","typeLabel":"string"},"standard_unit":{"description":"Standard unit","minLength":1,"type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.standard_unit","typeLabel":"string"},"type":{"description":"Unit type","example":"cost","type":"string","readOnly":true,"enum":["area","distance","energy","speed","temperature","time","volume","weight","cost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.type","typeLabel":"enum\u003cstring>"},"system":{"oneOf":[{"description":"Unit system","example":"metric","type":"string","enum":["metric","imperial"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.system.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Unit system","example":"metric","type":"null","enum":["metric","imperial"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.system.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.system","typeLabel":"enum\u003cstring> | null"},"symbol":{"oneOf":[{"description":"Unit symbol","example":"USD","maxLength":5,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.symbol.oneOf.0","typeLabel":"string"},{"description":"Unit symbol","example":"USD","maxLength":5,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit.symbol","typeLabel":"string | null"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].unit","typeLabel":"object"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].retailer","typeLabel":"object"},"updated_at":{"description":"Time of update","type":"string","format":"date-time","x-nullable":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"created_at":{"description":"Time of creation","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.attributes","typeLabel":"object[]"},"memos":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Memo ID","example":1234,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].id","typeLabel":"integer"},"text":{"description":"Memo text","example":"Immediate requirement","type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].text","typeLabel":"string"},"visibility":{"description":"Memo visibility","example":"any","type":"string","enum":["any","retailer","brand"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].visibility","typeLabel":"enum\u003cstring>"},"acknowledged_at":{"description":"Time memo acknowledgement (UTC format)","example":"2022-01-10T15:24:56Z","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].acknowledged_at","typeLabel":"string"},"notify_people":{"description":"true: notify stakeholders | false: do not notify","example":true,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].notify_people","typeLabel":"boolean"},"created_by":{"type":"object","properties":{"id":{"description":"User ID who accepted or rejected the invoice","example":542,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of the user photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of the user's profile photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: user is me | false: user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by.is_me","typeLabel":"boolean"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by","typeLabel":"object"},"created_by_context":{"oneOf":[{"description":"Represents whether memo is created by retailer or brand?","example":"retailer","type":"string","enum":["retailer","brand"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by_context.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Represents whether memo is created by retailer or brand?","example":"retailer","type":"null","enum":["retailer","brand"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_by_context","typeLabel":"enum\u003cstring> | null"},"created_at":{"description":"Time of memo creation (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of memo update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.memos","typeLabel":"object[]"},"issues":{"type":"array","items":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true,"description":"Issue ID","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].id","typeLabel":"integer"},"memos":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Memo ID","example":1234,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].id","typeLabel":"integer"},"text":{"description":"Memo text","example":"Immediate requirement","type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].text","typeLabel":"string"},"visibility":{"description":"Memo visibility","example":"any","type":"string","enum":["any","retailer","brand"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].visibility","typeLabel":"enum\u003cstring>"},"acknowledged_at":{"description":"Time memo acknowledgement (UTC format)","example":"2022-01-10T15:24:56Z","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].acknowledged_at","typeLabel":"string"},"notify_people":{"description":"true: notify stakeholders | false: do not notify","example":true,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].notify_people","typeLabel":"boolean"},"created_by":{"type":"object","properties":{"id":{"description":"User ID who accepted or rejected the invoice","example":542,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of the user photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of the user's profile photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: user is me | false: user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by.is_me","typeLabel":"boolean"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by","typeLabel":"object"},"created_by_context":{"oneOf":[{"description":"Represents whether memo is created by retailer or brand?","example":"retailer","type":"string","enum":["retailer","brand"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by_context.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Represents whether memo is created by retailer or brand?","example":"retailer","type":"null","enum":["retailer","brand"],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_by_context","typeLabel":"enum\u003cstring> | null"},"created_at":{"description":"Time of memo creation (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of memo update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos.items.[INDEX]","typeLabel":"object"},"readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].memos","typeLabel":"object[]"},"created_at":{"description":"Time of issue creation","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of issue update","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"resolved_at":{"description":"Time of issue resolution","type":"string","format":"date-time","x-nullable":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].resolved_at","typeLabel":"string\u003cdate-time>"},"is_resolved":{"description":"true: Issue is resolved | false: Issue is not resolved","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].is_resolved","typeLabel":"string"},"issue_id":{"description":"Issue ID","type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].issue_id","typeLabel":"integer"},"message":{"description":"Description or note related to issue","type":"string","readOnly":true,"minLength":1,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].message","typeLabel":"string"},"title":{"description":"Issue title","type":"string","readOnly":true,"minLength":1,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX].title","typeLabel":"string"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues.items.[INDEX]","typeLabel":"object"},"readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.issues","typeLabel":"object[]"},"variant_id":{"description":"Variant ID","example":249,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.variant_id","typeLabel":"integer"},"approved_at":{"oneOf":[{"description":"Time of approval (UTC format)","example":"2022-10-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.approved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of approval (UTC format)","example":"2022-10-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.approved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.approved_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"description":"Time of creation (UTC format)","example":"2022-07-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.updated_at","typeLabel":"string\u003cdate-time>"},"rejected_at":{"oneOf":[{"description":"Time of proposal rejection (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.rejected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of proposal rejection (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.rejected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.rejected_at","typeLabel":"string\u003cdate-time> | null"},"reject_reason":{"oneOf":[{"description":"Rejection reason","example":"Incomplete","maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.reject_reason.oneOf.0","typeLabel":"string"},{"description":"Rejection reason","example":"Incomplete","maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.reject_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.reject_reason","typeLabel":"string | null"},"reject":{"description":"true: proposal is rejected | false: proposal is not rejected","example":true,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.reject","typeLabel":"boolean"},"approve":{"description":"true: proposal is approved | false: proposal is not approved","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.approve","typeLabel":"boolean"},"delete":{"description":"true: proposal is deleted | false: proposal is not deleted","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant.delete","typeLabel":"boolean"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.proposal_variant","typeLabel":"object"},"retailer_identifiers":{"type":"object","properties":{"id":{"description":"Retailer ID","example":5642,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.id","typeLabel":"integer"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.retailer","typeLabel":"object"},"identifier":{"oneOf":[{"description":"Stock Keeping Unit (SKU), unique identifier of a product","example":"SKU976","maxLength":256,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.identifier.oneOf.0","typeLabel":"string"},{"description":"Stock Keeping Unit (SKU), unique identifier of a product","example":"SKU976","maxLength":256,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.identifier","typeLabel":"string | null"},"name":{"oneOf":[{"description":"Retailer name","example":"Retailer Sample","maxLength":256,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.name.oneOf.0","typeLabel":"string"},{"description":"Retailer name","example":"Retailer Sample","maxLength":256,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers.name","typeLabel":"string | null"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_identifiers","typeLabel":"object"},"retailer_categories":{"required":["category"],"type":"object","properties":{"category":{"description":"Category name","example":"CategoryANC","maxLength":256,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.category","typeLabel":"string"},"id":{"description":"Retailer category ID","example":453,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.id","typeLabel":"integer"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded | false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit | false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories.retailer","typeLabel":"object"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.retailer_categories","typeLabel":"object"},"inventory":{"required":["brand_inventory_updated_at","estimated_availability_date","inventory_last_submitted_at","inventory_updated_at","sellable_updated_at"],"type":"object","properties":{"inventory_updated_at":{"description":"Time of inventory update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.inventory_updated_at","typeLabel":"string\u003cdate-time>"},"inventory_last_submitted_at":{"description":"Time of inventory submit (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.inventory_last_submitted_at","typeLabel":"string\u003cdate-time>"},"brand_inventory_updated_at":{"description":"Time of vendor inventory update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.brand_inventory_updated_at","typeLabel":"string\u003cdate-time>"},"sellable_updated_at":{"description":"Time when product or variant was marked sellable (UTC format)","example":"2022-11-10T15:24:56Z","type":"string","format":"date-time","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.sellable_updated_at","typeLabel":"string\u003cdate-time>"},"estimated_availability_date":{"description":"Estimated delivery date (UTC format)","example":"2022-09-10T15:24:56Z","minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.estimated_availability_date","typeLabel":"string"},"discontinued":{"description":"true: Product is discontinued | false: Product is active","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.discontinued","typeLabel":"boolean"},"discontinued_updated_at":{"description":"Time of when product inventory was discontinued (UTC format)","example":null,"type":"string","format":"date-time","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.discontinued_updated_at","typeLabel":"string\u003cdate-time>"},"inventory":{"description":"Inventory of variant","example":0,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.inventory","typeLabel":"integer"},"sellable":{"description":"yes: Variant is sellable | No: Variant is not sellable","example":"No","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.sellable","typeLabel":"string"},"replenishable":{"description":"true: product is replenishable | false: product is not replenishable","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.replenishable","typeLabel":"boolean"},"locations":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Location ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].id","typeLabel":"integer"},"address":{"required":["city","country","name1","postal_code","province","street1"],"type":"object","properties":{"name1":{"description":"Name of the primary contact?","example":"Demo Brand, Inc","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.name1","typeLabel":"string"},"street1":{"description":"Line 1 of the address","example":"1332 Hermosa Ave","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.street1","typeLabel":"string"},"city":{"description":"City name","example":"Hermosa Beach","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.city","typeLabel":"string"},"province":{"description":"State name","example":"CA","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.province","typeLabel":"string"},"postal_code":{"description":"Postal code","example":"90254","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.postal_code","typeLabel":"string"},"country":{"description":"Country name","example":"US","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.country","typeLabel":"string"},"id":{"description":"Address ID","example":10,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.id","typeLabel":"integer"},"type":{"oneOf":[{"description":"Type of address","example":"residential","type":"string","enum":["residential","commercial"],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Type of address","example":"residential","type":"null","enum":["residential","commercial"],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.type","typeLabel":"enum\u003cstring> | null"},"name2":{"oneOf":[{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.name2.oneOf.0","typeLabel":"string"},{"description":"Name of the alternative contact?","example":null,"maxLength":64,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.name2.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.name2","typeLabel":"string | null"},"street2":{"oneOf":[{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.street2.oneOf.0","typeLabel":"string"},{"description":"Line 2 of the address","example":null,"maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.street2","typeLabel":"string | null"},"phone1":{"oneOf":[{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.phone1.oneOf.0","typeLabel":"string"},{"description":"Primary contact number","example":"3105551212","maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.phone1.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.phone1","typeLabel":"string | null"},"phone2":{"oneOf":[{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.phone2.oneOf.0","typeLabel":"string"},{"description":"Alternate contact number","example":"3105551213","maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.phone2.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.phone2","typeLabel":"string | null"},"fax":{"oneOf":[{"description":"Fax number","example":null,"maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.fax.oneOf.0","typeLabel":"string"},{"description":"Fax number","example":null,"maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.fax","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Contact email address","example":null,"maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.email.oneOf.0","typeLabel":"string"},{"description":"Contact email address","example":null,"maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.email","typeLabel":"string | null"},"federal_tax_id":{"oneOf":[{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.federal_tax_id.oneOf.0","typeLabel":"string"},{"description":"Federal tax ID ","example":null,"maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.federal_tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address.federal_tax_id","typeLabel":"string | null"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].address","typeLabel":"object"},"inventory":{"description":"Count of sellable variants","example":0,"type":"integer","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].inventory","typeLabel":"integer"},"nickname":{"description":"Nickname of location","example":"LA Warehouse","type":"string","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX].nickname","typeLabel":"string"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory.locations","typeLabel":"object[]"}},"uniqueKey":"invoice_lines.items.[INDEX].variant.inventory","typeLabel":"object"}},"uniqueKey":"invoice_lines.items.[INDEX].variant","typeLabel":"object"},"invoice_line_number":{"oneOf":[{"description":"Invoice line number","example":2,"maximum":2147483647,"minimum":-2147483648,"type":"integer","uniqueKey":"invoice_lines.items.[INDEX].invoice_line_number.oneOf.0","typeLabel":"integer"},{"description":"Invoice line number","example":2,"maximum":2147483647,"minimum":-2147483648,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].invoice_line_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].invoice_line_number","typeLabel":"integer | null"},"item_brand_identifier":{"oneOf":[{"description":"Vendor identifier of product","example":"Vend134","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].item_brand_identifier.oneOf.0","typeLabel":"string"},{"description":"Vendor identifier of product","example":"Vend134","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].item_brand_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].item_brand_identifier","typeLabel":"string | null"},"item_upc":{"oneOf":[{"description":"Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in the marketplace system","example":"911911911112","maxLength":32,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].item_upc.oneOf.0","typeLabel":"string"},{"description":"Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in the marketplace system","example":"911911911112","maxLength":32,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].item_upc.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].item_upc","typeLabel":"string | null"},"name":{"oneOf":[{"description":"Product name","example":"SamPro1","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"description":"Product name","example":"SamPro1","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].name","typeLabel":"string | null"},"description":{"oneOf":[{"description":"Product description","example":"Sample description of product","maxLength":128,"type":"string","uniqueKey":"invoice_lines.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Product description","example":"Sample description of product","maxLength":128,"type":"null","uniqueKey":"invoice_lines.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].description","typeLabel":"string | null"},"canceled_at":{"oneOf":[{"description":"Time of cancellation (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of cancellation (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"invoice_lines.items.[INDEX].canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_lines.items.[INDEX].canceled_at","typeLabel":"string\u003cdate-time> | null"},"retail_price":{"description":"Retail price","example":"14.00","type":"string","format":"decimal","readOnly":true,"uniqueKey":"invoice_lines.items.[INDEX].retail_price","typeLabel":"string\u003cdecimal>"}},"uniqueKey":"invoice_lines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice_lines","typeLabel":"object[]"},"net_amount":{"oneOf":[{"description":"Total invoice amount (excluding taxes)","example":"12.89","type":"string","format":"decimal","uniqueKey":"net_amount.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Total invoice amount (excluding taxes)","example":"12.89","type":"null","format":"decimal","uniqueKey":"net_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"net_amount","typeLabel":"string\u003cdecimal> | null"},"due_amount":{"oneOf":[{"description":"Pending amount","example":"2.89","type":"string","format":"decimal","uniqueKey":"due_amount.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Pending amount","example":"2.89","type":"null","format":"decimal","uniqueKey":"due_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"due_amount","typeLabel":"string\u003cdecimal> | null"},"expected_due_amount":{"oneOf":[{"description":"Expected due amount (excluding *allowances* and *charges*)","example":"2.89","type":"string","format":"decimal","uniqueKey":"expected_due_amount.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Expected due amount (excluding *allowances* and *charges*)","example":"2.89","type":"null","format":"decimal","uniqueKey":"expected_due_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"expected_due_amount","typeLabel":"string\u003cdecimal> | null"},"subtotal":{"oneOf":[{"description":"Sub-total","example":"10.89","type":"string","format":"decimal","uniqueKey":"subtotal.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Sub-total","example":"10.89","type":"null","format":"decimal","uniqueKey":"subtotal.oneOf.1","typeLabel":"null"}],"uniqueKey":"subtotal","typeLabel":"string\u003cdecimal> | null"},"tax":{"oneOf":[{"description":"Total tax on the invoice","example":"2.00","type":"string","format":"decimal","uniqueKey":"tax.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Total tax on the invoice","example":"2.00","type":"null","format":"decimal","uniqueKey":"tax.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax","typeLabel":"string\u003cdecimal> | null"},"invoice_acceptance":{"type":"object","properties":{"id":{"description":"Invoice acceptance ID","example":565,"type":"integer","readOnly":true,"uniqueKey":"invoice_acceptance.id","typeLabel":"integer"},"accepted_by":{"type":"object","properties":{"id":{"description":"User ID who accepted or rejected the invoice","example":542,"type":"integer","readOnly":true,"uniqueKey":"invoice_acceptance.accepted_by.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.accepted_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.accepted_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.accepted_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.accepted_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.accepted_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.accepted_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"invoice_acceptance.accepted_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"invoice_acceptance.accepted_by.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of the user photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_acceptance.accepted_by.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of the user's profile photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_acceptance.accepted_by.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: user is me | false: user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_acceptance.accepted_by.is_me","typeLabel":"boolean"}},"description":"Vendor acceptance","uniqueKey":"invoice_acceptance.accepted_by","typeLabel":"object"},"rejected_by":{"type":"object","properties":{"id":{"description":"User ID who accepted or rejected the invoice","example":542,"type":"integer","readOnly":true,"uniqueKey":"invoice_acceptance.rejected_by.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.rejected_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.rejected_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.rejected_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.rejected_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"invoice_acceptance.rejected_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"invoice_acceptance.rejected_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"invoice_acceptance.rejected_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"invoice_acceptance.rejected_by.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of the user photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_acceptance.rejected_by.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of the user's profile photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"invoice_acceptance.rejected_by.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: user is me | false: user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"invoice_acceptance.rejected_by.is_me","typeLabel":"boolean"}},"uniqueKey":"invoice_acceptance.rejected_by","typeLabel":"object"},"reject_reason":{"oneOf":[{"description":"Reason for invoice rejection","example":"Incorrect","maxLength":128,"type":"string","uniqueKey":"invoice_acceptance.reject_reason.oneOf.0","typeLabel":"string"},{"description":"Reason for invoice rejection","example":"Incorrect","maxLength":128,"type":"null","uniqueKey":"invoice_acceptance.reject_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.reject_reason","typeLabel":"string | null"},"accepted_at":{"oneOf":[{"description":"Time when the invoice was accepted (UTC format).","example":"2022-08-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"invoice_acceptance.accepted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when the invoice was accepted (UTC format).","example":"2022-08-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"invoice_acceptance.accepted_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.accepted_at","typeLabel":"string\u003cdate-time> | null"},"rejected_at":{"oneOf":[{"description":"Time when the invoice was accepted (UTC format).","example":null,"type":"string","format":"date-time","uniqueKey":"invoice_acceptance.rejected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time when the invoice was accepted (UTC format).","example":null,"type":"null","format":"date-time","uniqueKey":"invoice_acceptance.rejected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice_acceptance.rejected_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"invoice_acceptance","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"invoice_number":"RC123456","id":1,"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"brand":{"code":"demo-brand","id":500,"name":"Marla Cielo","joined_at":"2022-09-10T15:24:56Z","logo_url":"https://images.revcascade.com/retailers/defaults/logo-lg.png","cover_url":"https://images.revcascade.com/retailers/defaults/cover.png","profile_tile_url":"https://images.revcascade.com/retailers/defaults/profile-tile.png","website":null,"is_onboarded":false,"is_on_rcn":false,"requires_subscription":"enabled","subscription_expires_at":"2024-09-19T13:32:10Z","grace_period_ends_at":"2024-10-26T13:32:10Z","subscription_is_expired":false,"subscription_is_on_grace_period":false,"subscription_is_delinquent":false,"inventory_policy":"managed","status":"active"},"connection_id":2,"currency":{"id":1,"name":"United States Dollar","symbol":"$","unit":"USD"},"terms_type":"Previously agreed upon","terms_description":"Previously agreed upon terms will apply","terms_net_days_due":35,"terms_date_due":null,"terms_discount_percent":null,"order_id":"O-654","customer_order_number":"CO-435","purchase_order_number":"PO-546","status":"closed","remit_to":{"name1":"Demo Brand, Inc","street1":"1332 Hermosa Ave","city":"Hermosa Beach","province":"CA","postal_code":"90254","country":"US","id":10,"type":"residential","name2":null,"street2":null,"phone1":"3105551212","phone2":"3105551213","fax":null,"email":null,"federal_tax_id":null},"ship_from":{"name1":"Demo Brand, Inc","street1":"1332 Hermosa Ave","city":"Hermosa Beach","province":"CA","postal_code":"90254","country":"US","id":10,"type":"residential","name2":null,"street2":null,"phone1":"3105551212","phone2":"3105551213","fax":null,"email":null,"federal_tax_id":null},"sold_to":{"name1":"Demo Brand, Inc","street1":"1332 Hermosa Ave","city":"Hermosa Beach","province":"CA","postal_code":"90254","country":"US","id":10,"type":"residential","name2":null,"street2":null,"phone1":"3105551212","phone2":"3105551213","fax":null,"email":null,"federal_tax_id":null},"ship_to":{"name1":"Demo Brand, Inc","street1":"1332 Hermosa Ave","city":"Hermosa Beach","province":"CA","postal_code":"90254","country":"US","id":10,"type":"residential","name2":null,"street2":null,"phone1":"3105551212","phone2":"3105551213","fax":null,"email":null,"federal_tax_id":null},"shipping_carrier_name":"ALZ carrier","shipping_carrier_code":"230F","shipping_account_number":"SH879","shipping_method_name":"Next day delivery","shipping_method_code":"ND","shipping_tracking_number":"1Z9999999999999988","shipping_weight":"7.00","notes":"Signature required","invoiced_at":"2022-05-10T15:24:56Z","ordered_at":"2022-05-10T15:24:56Z","shipped_at":"2022-05-10T15:24:56Z","acknowledged_at":"2022-06-10T15:24:56Z","paid_at":"2022-06-10T15:24:56Z","closed_at":null,"canceled_at":null,"allowances":[{"description":"Sample-discount-allowance","price":"12.10","id":1,"adjustment_code":{"adjustment_type":"Allowance","code":"returns_allowance","description":"returns_allowance","id":1}}],"charges":[{"description":"Sample invoice and its description","price":"23.45","id":654,"adjustment_code":{"adjustment_type":"Allowance","code":"returns_allowance","description":"returns_allowance","id":1}}],"invoice_lines":[{"quantity":45,"price":"12.00","id":765,"variant":{"id":100024,"name":"T-Shirt, Blue, L","brand":{"code":"demo-brand","id":500,"name":"Marla Cielo","joined_at":"2022-09-10T15:24:56Z","logo_url":"https://images.revcascade.com/retailers/defaults/logo-lg.png","cover_url":"https://images.revcascade.com/retailers/defaults/cover.png","profile_tile_url":"https://images.revcascade.com/retailers/defaults/profile-tile.png","website":null,"is_onboarded":false,"is_on_rcn":false,"requires_subscription":"enabled","subscription_expires_at":"2024-09-19T13:32:10Z","grace_period_ends_at":"2024-10-26T13:32:10Z","subscription_is_expired":false,"subscription_is_on_grace_period":false,"subscription_is_delinquent":false,"inventory_policy":"managed","status":"active"},"brand_identifier":"1000-BL-L","identifier":"5000001","upc":9119119111,"cartons":[{"id":48,"number":1,"length":"1","length_unit":"1","width":"1","width_unit":"meter","height":"1","height_unit":"meter","weight":"15","weight_unit":"KG","package_girth_inches":"1","package_size_inches":"1"}],"color":"Red","style":"Print","size":"Large","media":[{"id":249,"width":100,"height":100,"media":"default","priority":1,"url":"https://cdn.example.com/media/default/original","updated_at":"2022-09-10T15:24:56Z","created_at":"2022-08-10T15:24:56Z"}],"attributes":[{"code":"size","name":"Size","type":"money","id":44,"editable_by":"brand","grouping":"general","description":"demo product description","units":"USD","values":{"id":123,"value":"\u003cstring>","unit":{"id":677,"name":"Sample unit","standard_unit":"\u003cstring>","type":"cost","system":"metric","symbol":"USD"},"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"updated_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z"}}],"ruleset_variants":[{"id":1232,"status":"processing","results":"\u003cstring>","created_at":"2022-08-10T15:24:56Z","updated_at":"2022-09-10T15:24:56Z"}],"ruleset_variant_summary":"21","active_permit":{"id":10104,"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"retailer_price":"12.99","retailer_cost":"8.99","pricing":{},"attributes":{},"start_at":"2021-09-10T15:24:56Z","end_at":"2024-09-10T15:24:56Z","is_in_effect":true,"revoked_at":"2022-09-10T15:24:56Z","is_acknowledged":true,"acknowledged_at":"2022-09-10T15:24:56Z"},"permits":[{"id":10104,"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"retailer_price":"12.99","retailer_cost":"8.99","pricing":{},"attributes":{},"start_at":"2021-09-10T15:24:56Z","end_at":"2024-09-10T15:24:56Z","is_in_effect":true,"revoked_at":"2022-09-10T15:24:56Z","is_acknowledged":true,"acknowledged_at":"2022-09-10T15:24:56Z"}],"is_compatible":true,"proposal_variant":{"id":3456,"pricing":"12.00","attributes":[{"id":123,"value":"\u003cstring>","unit":{"id":677,"name":"Sample unit","standard_unit":"\u003cstring>","type":"cost","system":"metric","symbol":"USD"},"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"updated_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z"}],"memos":[{"id":1234,"text":"Immediate requirement","visibility":"any","acknowledged_at":"2022-01-10T15:24:56Z","notify_people":true,"created_by":{"id":542,"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"created_by_context":"retailer","created_at":"2021-09-10T15:24:56Z","updated_at":"2022-09-10T15:24:56Z"}],"issues":[{"id":123,"memos":[{"id":1234,"text":"Immediate requirement","visibility":"any","acknowledged_at":"2022-01-10T15:24:56Z","notify_people":true,"created_by":{"id":542,"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"created_by_context":"retailer","created_at":"2021-09-10T15:24:56Z","updated_at":"2022-09-10T15:24:56Z"}],"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","resolved_at":"2023-11-07T05:31:56Z","is_resolved":"\u003cstring>","issue_id":123,"message":"\u003cstring>","title":"\u003cstring>"}],"variant_id":249,"approved_at":"2022-10-10T15:24:56Z","created_at":"2022-07-10T15:24:56Z","updated_at":"2022-09-10T15:24:56Z","rejected_at":null,"reject_reason":"Incomplete","reject":true,"approve":false,"delete":false},"retailer_identifiers":{"id":5642,"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"identifier":"SKU976","name":"Retailer Sample"},"retailer_categories":{"category":"CategoryANC","id":453,"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"}},"inventory":{"inventory_updated_at":"2022-09-10T15:24:56Z","inventory_last_submitted_at":"2022-09-10T15:24:56Z","brand_inventory_updated_at":"2022-09-10T15:24:56Z","sellable_updated_at":"2022-11-10T15:24:56Z","estimated_availability_date":"2022-09-10T15:24:56Z","discontinued":true,"discontinued_updated_at":null,"inventory":0,"sellable":"No","replenishable":true,"locations":[{"id":1,"address":{"name1":"Demo Brand, Inc","street1":"1332 Hermosa Ave","city":"Hermosa Beach","province":"CA","postal_code":"90254","country":"US","id":10,"type":"residential","name2":null,"street2":null,"phone1":"3105551212","phone2":"3105551213","fax":null,"email":null,"federal_tax_id":null},"inventory":0,"nickname":"LA Warehouse"}]}},"invoice_line_number":2,"item_brand_identifier":"Vend134","item_upc":"911911911112","name":"SamPro1","description":"Sample description of product","canceled_at":null,"retail_price":"14.00"}],"net_amount":"12.89","due_amount":"2.89","expected_due_amount":"2.89","subtotal":"10.89","tax":"2.00","invoice_acceptance":{"id":565,"accepted_by":{"id":542,"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"rejected_by":{"id":542,"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"reject_reason":"Incorrect","accepted_at":"2022-08-10T15:24:56Z","rejected_at":null}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"147054be-81bb-4902-ab21-6b747fcd48c6":{"Bearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"208b8719-3cac-4d6f-8c2e-bfd5df078d89":{"url":"https://marketplace-api.fabric.inc","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi/dropship/dropship_invoice.openapi.yaml"},"subdomain":"fabric-demo","siteName":"Fabric","title":"Acknowledge receipt of an invoice. - Fabric","navMaps":{"firstHrefInVersion":{"Product Agent":{"href":"/home","matchLevel":4},"v3":{"href":"/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id","matchLevel":0},"v2":{"href":"/v2/home","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T21:06:40.125Z","originalFileLocation":"v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id.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=\"As a merchant, you should include is_acknowledged=0 as a query string parameter to get only new invoices. Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint doesn\u0026#x27;t return processed shipments.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fabric\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Acknowledge receipt of an invoice. - Fabric\">\u003cmeta data-mint-head property=\"og:description\" content=\"As a merchant, you should include is_acknowledged=0 as a query string parameter to get only new invoices. Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint doesn\u0026#x27;t return processed shipments.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fabric\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fabric-demo.mintlify.app/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Acknowledge+receipt+of+an+invoice.\u0026amp;description=As+a+merchant%2C+you+should+include+%60is_acknowledged%3D0%60+as+a+query+string+parameter+to+get+only+new+invoices.+%3Cbr+%2F%3E+%3Cbr+%2F%3E+Then%2C+for+each+shipment+returned%2C+you+\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=2b6c3d653fdaca6e644e311ee34a8e2f2c9b821e1895274125b3b0f05e8feb14\">\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=\"Acknowledge receipt of an invoice. - Fabric\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"As a merchant, you should include is_acknowledged=0 as a query string parameter to get only new invoices. Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint doesn\u0026#x27;t return processed shipments.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fabric-demo.mintlify.app/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Acknowledge+receipt+of+an+invoice.\u0026amp;description=As+a+merchant%2C+you+should+include+%60is_acknowledged%3D0%60+as+a+query+string+parameter+to+get+only+new+invoices.+%3Cbr+%2F%3E+%3Cbr+%2F%3E+Then%2C+for+each+shipment+returned%2C+you+\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=2b6c3d653fdaca6e644e311ee34a8e2f2c9b821e1895274125b3b0f05e8feb14\">\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/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fabric\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff2ec1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.fabric.inc/#organization\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.fabric.inc#website\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id#webpage\",\"url\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id\",\"name\":\"Acknowledge receipt of an invoice.\",\"description\":\"As a merchant, you should include is_acknowledged=0 as a query string parameter to get only new invoices. Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint doesn't return processed shipments.\",\"dateModified\":\"2026-01-22T21:06:40.125Z\",\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"},\"breadcrumb\":{\"@id\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Merchant API Endpoints\",\"item\":\"https://developer.fabric.inc/v3/dropship/api-reference/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invoices\",\"item\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/get-invoices\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Acknowledge receipt of an invoice.\",\"item\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id#apireference\",\"headline\":\"Acknowledge receipt of an invoice.\",\"name\":\"Acknowledge receipt of an invoice.\",\"description\":\"As a merchant, you should include is_acknowledged=0 as a query string parameter to get only new invoices. Then, for each shipment returned, you should process the shipment and update any necessary internal systems (such as OMS or ERP). After processing a shipment successfully, you can acknowledge the shipment using this endpoint so that subsequent queries to the /shipments/?is_acknowledged=0 endpoint doesn't return processed shipments.\",\"url\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://developer.fabric.inc/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id#webpage\"},\"dateModified\":\"2026-01-22T21:06:40.125Z\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"}}]}\u003c/script>","siteName":"Fabric","nav":{"global":null,"versions":[{"version":"Product Agent","pages":[{"title":"Product Agent","href":"/home"}]},{"version":"v3","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/v3/home"}]},{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/v3/getting-started/overview"}]},{"tab":"Orders \u0026 Inventory","pages":[{"title":"Orders \u0026 Inventory","href":"/v3/orders-and-inventory/homepage"}]},{"tab":"Product Catalog","pages":[{"title":"Product Catalog","href":"/v3/product-catalog/getting-started"}]},{"tab":"Offers","pages":[{"title":"Offers","href":"/v3/offers/user-guides/offers/overview"}]},{"tab":"Dropship","groups":[{"group":"Dropship","pages":[{"title":"Dropship by fabric","href":"/v3/dropship/homepage"}]},{"group":"Merchants","pages":[{"title":"fabric Dropship for Merchants","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/overview"},{"title":"Plan Your Dropship Implementation","href":"/v3/dropship/dropship-retailers/implimentation-planning-guide"},{"title":"Merchant Best Practices","href":"/v3/dropship/dropship-retailers/merchant_best_practices"},{"group":"Integrations","pages":[{"title":"Dropship Integrations Overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/integrations/overview"},{"title":"fabric Integration","href":"/v3/dropship/dropship-retailers/integrations/fabric-integration"},{"title":"Dropship Shopify Integration","href":"/v3/dropship/dropship-retailers/integrations/shopify-integration"},{"title":"BigCommerce Integration","href":"/v3/dropship/dropship-retailers/integrations/bigcommerce-integration-1"},{"title":"Loop Integration","href":"/v3/dropship/dropship-retailers/integrations/loop-integration"},{"title":"Integrating with Dropship APIs","href":"/v3/dropship/dropship-retailers/integrations/api-integration"}]},{"group":"Orders","pages":[{"title":"Merchant Orders UI Overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/orders/overview"},{"title":"Order Details in Dropship","href":"/v3/dropship/dropship-retailers/orders/order-detail"},{"title":"Managing cancels \u0026 backorders","href":"/v3/dropship/dropship-retailers/orders/managing-cancels---backorders"},{"title":"Creating a Purchase Order in Dropship","href":"/v3/dropship/dropship-retailers/orders/create-purchase-order"},{"title":"Create a Return Request","href":"/v3/dropship/dropship-retailers/orders/create-a-return"},{"title":"Managing Invoices","href":"/v3/dropship/dropship-retailers/orders/invoices"},{"title":"Auto-Invoicing","href":"/v3/dropship/dropship-retailers/orders/auto-invoicing"},{"group":"Reports","pages":[{"title":"Viewing Shipment Reports","href":"/v3/dropship/dropship-retailers/orders/order-reports/shipment-reports"},{"title":"Viewing Return Reports","href":"/v3/dropship/dropship-retailers/orders/order-reports/return-reports"},{"title":"Viewing Cancellation Reports","href":"/v3/dropship/dropship-retailers/orders/order-reports/cancel-reports"},{"title":"Viewing Invoice Reports","href":"/v3/dropship/dropship-retailers/orders/order-reports/invoice-reports"},{"title":"Viewing Credit Memo Reports","href":"/v3/dropship/dropship-retailers/orders/order-reports/credit-memo-reports"}]}]},{"group":"Products","pages":[{"title":"Dropship Products UI Overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/products/overview"},{"title":"Inventory","href":"/v3/dropship/dropship-retailers/products/inventory"},{"title":"Proposals","href":"/v3/dropship/dropship-retailers/products/proposals"},{"title":"Dropship Product Attribute List","sidebarTitle":"Product Attributes","href":"/v3/dropship/dropship-retailers/products/attributes"},{"title":"Submit and Manage Import Requests","href":"/v3/dropship/dropship-retailers/products/import-requests"},{"title":"Importing Products \u0026 Attributes","href":"/v3/dropship/dropship-retailers/products/import-products-attributes"},{"title":"Publishing Products to BigCommerce","href":"/v3/dropship/dropship-retailers/products/bigcommerce-publish-products"},{"group":"Shopify","pages":[{"title":"Publishing Products to Shopify","href":"/v3/dropship/dropship-retailers/products/shopify/shopify-publish-products"},{"title":"Publishing Shopify Products Best Practices","href":"/v3/dropship/dropship-retailers/products/shopify/best-practices"},{"title":"Checking a Job Status in Shopify","href":"/v3/dropship/dropship-retailers/products/shopify/shopify-job-status"}]}]},{"group":"Suppliers","pages":[{"title":"Merchant Supplier UI Overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/suppliers/overview"},{"title":"Inviting Suppliers to Dropship","href":"/v3/dropship/dropship-retailers/suppliers/inviting-suppliers"},{"title":"Suspending a Supplier","href":"/v3/dropship/dropship-retailers/suppliers/suspending-suppliers"},{"group":"Supplier Management","pages":[{"title":"Supplier Management for Merchants","sidebarTitle":"Supplier Management","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/supplier-details"},{"title":"Viewing Supplier Locations","sidebarTitle":"Supplier Locations","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/supplier-locations"},{"title":"Managing Supplier Attributes for Merchants","sidebarTitle":"Supplier Attributes","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/supplier-attributes"},{"title":"Managing Supplier Carrier Accounts for Merchants","sidebarTitle":"Supplier Carriers","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/supplier-carriers"},{"title":"Viewing a Supplier's Onboarding Status","sidebarTitle":"Supplier Onboarding","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/supplier-onboarding"},{"title":"Exporting a List of Suppliers","sidebarTitle":"Exporting Suppliers","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/exporting-suppliers"},{"title":"Safety Stock","href":"/v3/dropship/dropship-retailers/suppliers/supplier-management/safety-stock"}]}]},{"group":"Reports","pages":[{"title":"Dropship Reporting Overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/reports/reports"},{"title":"Sales Performance Reporting","href":"/v3/dropship/dropship-retailers/reports/sales-performance-reporting"},{"title":"Supplier Compliance Reporting","href":"/v3/dropship/dropship-retailers/reports/compliance-reporting"},{"title":"Compliance Scorecard","href":"/v3/dropship/dropship-retailers/reports/compliance-scorecard"}]},{"group":"Settings","pages":[{"title":"Merchant Settings Overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-retailers/settings/overview"},{"title":"General Information Settings","href":"/v3/dropship/dropship-retailers/settings/general-information"},{"title":"API Client Settings","href":"/v3/dropship/dropship-retailers/settings/api-clients"},{"title":"Attribute Value Transformer Settings","href":"/v3/dropship/dropship-retailers/settings/attribute-value-transformers"},{"title":"Branding Settings","href":"/v3/dropship/dropship-retailers/settings/branding"},{"title":"Category Settings","href":"/v3/dropship/dropship-retailers/settings/categories"},{"title":"Commission Profile Settings","href":"/v3/dropship/dropship-retailers/settings/commission-profiles"},{"title":"Currency Settings","href":"/v3/dropship/dropship-retailers/settings/currency-settings"},{"title":"Default Onboarding Settings","href":"/v3/dropship/dropship-retailers/settings/default-onboarding"},{"title":"Integration Settings","href":"/v3/dropship/dropship-retailers/settings/integrations"},{"title":"Notification Settings","href":"/v3/dropship/dropship-retailers/settings/notifications"},{"title":"Proposal Department Settings","href":"/v3/dropship/dropship-retailers/settings/proposal-departments"},{"title":"Retailer SKU Settings","href":"/v3/dropship/dropship-retailers/settings/retailer-sku-settings"},{"title":"Product Ruleset Settings","href":"/v3/dropship/dropship-retailers/settings/rulesets"},{"title":"Shipping Account Settings","sidebarTitle":"Shipping Accounts","href":"/v3/dropship/dropship-retailers/settings/shipping-accounts"},{"title":"Product and Inventory Template Settings","href":"/v3/dropship/dropship-retailers/settings/templates"},{"title":"Terms of Service Settings","href":"/v3/dropship/dropship-retailers/settings/terms-of-service"},{"title":"Tracking Number History Settings","href":"/v3/dropship/dropship-retailers/settings/tracking-number-history"},{"title":"User Management","href":"/v3/dropship/dropship-retailers/settings/user-management"},{"group":"Webhooks","pages":[{"title":"Webhook Settings","href":"/v3/dropship/dropship-retailers/settings/webhooks/webhooks"},{"title":"Webhook Example Payloads","href":"/v3/dropship/dropship-retailers/settings/webhooks/examples"},{"title":"Webhook FAQs","href":"/v3/dropship/dropship-retailers/settings/webhooks/faq"}]}]},{"title":"Checking Job Statuses","sidebarTitle":"Job Reports","href":"/v3/dropship/dropship-retailers/checking-job-status"},{"title":"Support","href":"/v3/dropship/dropship-retailers/support"}]},{"group":"Merchant API Endpoints","pages":[{"title":"Authentication in Dropship","href":"/v3/dropship/api-reference/authentication"},{"group":"Carriers","pages":[{"openapi":"carriers.openapi get /v1/retailers/{retailer_id}/carriers/","title":"List all carriers","href":"/v3/dropship/api-reference/merchant/carriers/get-carriers"}]},{"group":"Compliance Reports","pages":[{"openapi":"compliance_report.openapi get /v1/retailers/{retailer_id}/compliance-reports/","title":"List compliance reports","href":"/v3/dropship/api-reference/merchant/compliance-reports/get-compliance-reports"},{"openapi":"compliance_report.openapi get /v1/retailers/{retailer_id}/compliance-reports/{id}/","title":"Get compliance report details","href":"/v3/dropship/api-reference/merchant/compliance-reports/get-compliance-reports-by-id"}]},{"group":"Connection Invites","pages":[{"openapi":"connection_invites.openapi get /v1/retailers/{retailer_id}/connections/","title":"Get vendor connections","href":"/v3/dropship/api-reference/merchant/connection-invites/get-invites"},{"openapi":"connection_invites.openapi get /v1/retailers/{retailer_id}/connection-invites/{id}/","title":"Get connection invite by ID","href":"/v3/dropship/api-reference/merchant/connection-invites/get-invite-by-id"},{"openapi":"connection_invites.openapi get /v1/retailers/{retailer_id}/connections/t-and-c-status/","title":"Get terms \u0026 conditions status","href":"/v3/dropship/api-reference/merchant/connection-invites/get-terms-and-conditions"}]},{"group":"Inventory","pages":[{"openapi":"dropship_inventory.openapi get /v1/retailers/{retailer_id}/inventory/","title":"List inventory","href":"/v3/dropship/api-reference/merchant/inventory/get-inventory"},{"openapi":"dropship_inventory.openapi get /v1/retailers/{retailer_id}/inventory/{id}/","title":"Get inventory item","href":"/v3/dropship/api-reference/merchant/inventory/get-inventory-by-id"},{"openapi":"dropship_inventory.openapi get /v1/retailers/{retailer_id}/inventory/{id}/history/","title":"Get inventory history","href":"/v3/dropship/api-reference/merchant/inventory/get-history"}]},{"group":"Invoices","pages":[{"openapi":"dropship_invoice.openapi get /v1/retailers/{retailer_id}/invoices/","title":"List invoices from vendors","href":"/v3/dropship/api-reference/merchant/invoice/get-invoices"},{"openapi":"dropship_invoice.openapi get /v1/retailers/{retailer_id}/invoices/{id}/","title":"Get invoice details","description":"Retrieve the details of a specific invoice.","href":"/v3/dropship/api-reference/merchant/invoice/get-invoice-by-id"},{"openapi":"dropship_invoice.openapi put /v1/retailers/{retailer_id}/invoices/{id}/acknowledge/","title":"Acknowledge receipt of an invoice.","href":"/v3/dropship/api-reference/merchant/invoice/acknowledge-invoice-by-id"}]},{"group":"Orders","pages":[{"openapi":"dropship_orders.openapi get /v1/retailers/{retailer_id}/orders/","title":"Get orders","description":"Gets a list of orders.","href":"/v3/dropship/api-reference/merchant/orders/get-orders"},{"openapi":"dropship_orders.openapi get /v1/retailers/{retailer_id}/orders/{id}/","title":"Get single order details","href":"/v3/dropship/api-reference/merchant/orders/get-specific-order"},{"openapi":"dropship_orders.openapi get /v1/retailers/{retailer_id}/orders/memos/","title":"Get order memos","href":"/v3/dropship/api-reference/merchant/orders/get-order-memos"},{"openapi":"dropship_orders.openapi post /v1/retailers/{retailer_id}/orders/","title":"Create a new order (for a single vendor)","href":"/v3/dropship/api-reference/merchant/orders/create-orders"},{"openapi":"dropship_orders.openapi post /v1/retailers/{retailer_id}/sales-orders/","title":"Create a new order (mixed vendors)","href":"/v3/dropship/api-reference/merchant/orders/create-brands"},{"openapi":"dropship_orders.openapi post /v1/retailers/{retailer_id}/orders/{id}/tags/","title":"Create order tags","href":"/v3/dropship/api-reference/merchant/orders/add-tags"},{"openapi":"dropship_orders.openapi post /v1/retailers/{retailer_id}/orders/{id}/memos/","title":"Create an order memo","href":"/v3/dropship/api-reference/merchant/orders/create-memos"},{"openapi":"dropship_orders.openapi put /v1/retailers/{retailer_id}/orders/{id}/acknowledge-all-unread-memos/","title":"Acknowledge unread memos","href":"/v3/dropship/api-reference/merchant/orders/acknowledge-unread-memos"},{"openapi":"dropship_orders.openapi put /v1/retailers/{retailer_id}/orders/{id}/acknowledge-backorder/","title":"Acknowledge a backorder","href":"/v3/dropship/api-reference/merchant/orders/acknowledge-backorders"},{"openapi":"dropship_orders.openapi put /v1/retailers/{retailer_id}/orders/acknowledge-backorder/","title":"Acknowledge backorders","href":"/v3/dropship/api-reference/merchant/orders/acknowledge-backorders-bulk"},{"openapi":"dropship_orders.openapi post /v1/retailers/{retailer_id}/orders/{id}/cancel/","title":"Cancel an Order","href":"/v3/dropship/api-reference/merchant/orders/cancel-orders"}]},{"group":"Products","pages":[{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/products/{id}/","title":"Get a product by ID","href":"/v3/dropship/api-reference/merchant/products/get-product-by-id"},{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/products/{id}/variants/","title":"Get all variants of a product","href":"/v3/dropship/api-reference/merchant/products/get-product-variant"},{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/variants/","title":"Get all variants","href":"/v3/dropship/api-reference/merchant/products/get-all-varients"},{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/variants/{id}/","title":"Get a variant by ID","href":"/v3/dropship/api-reference/merchant/products/get-variant-details"},{"openapi":"dropship_products.openapi patch /v1/retailers/{retailer_id}/variants/{id}/","title":"Update variant attributes","href":"/v3/dropship/api-reference/merchant/products/update-variant-attributes"},{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/permits/{id}/","title":"Get a permit","href":"/v3/dropship/api-reference/merchant/products/get-permits"},{"openapi":"dropship_products.openapi put /v1/retailers/{retailer_id}/permits/{id}/acknowledge/","title":"Acknowledge a permit receipt","href":"/v3/dropship/api-reference/merchant/products/acknowledge-permits"},{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/fabric/{fabric_id}/templates/","title":"List fabric templates","href":"/v3/dropship/api-reference/merchant/products/get-product-templates"},{"openapi":"dropship_products.openapi get /v1/retailers/{retailer_id}/fabric/{fabric_id}/templates/{id}/","title":"Get a fabric template","href":"/v3/dropship/api-reference/merchant/products/get-template-by-id"},{"openapi":"dropship_products.openapi post /v1/retailers/{retailer_id}/fabric/{fabric_id}/templates/","title":"Create a fabric template","href":"/v3/dropship/api-reference/merchant/products/create-a-product-template"},{"openapi":"dropship_products.openapi put /v1/retailers/{retailer_id}/fabric/{fabric_id}/templates/{id}/","title":"Update a fabric template","href":"/v3/dropship/api-reference/merchant/products/update-template-by-id"},{"openapi":"dropship_products.openapi patch /v1/retailers/{retailer_id}/fabric/{fabric_id}/templates/{id}/","title":"Partially update a fabric template","href":"/v3/dropship/api-reference/merchant/products/partially-update-template"},{"openapi":"dropship_products.openapi delete /v1/retailers/{retailer_id}/fabric/{fabric_id}/templates/{id}/","title":"Delete a fabric template","href":"/v3/dropship/api-reference/merchant/products/delete-a-template"}]},{"group":"Proposals","pages":[{"openapi":"dropship_proposals.openapi get /v1/retailers/{retailer_id}/proposals/products/","title":"Get all product proposals","href":"/v3/dropship/api-reference/merchant/proposals/get-proposed-products"},{"openapi":"dropship_proposals.openapi get /v1/retailers/{retailer_id}/proposals/{id}/","title":"Get a specific proposal","href":"/v3/dropship/api-reference/merchant/proposals/get-proposal-details-by-id"},{"openapi":"dropship_proposals.openapi get /v1/retailers/{retailer_id}/proposals/{id}/proposal-products/","title":"List proposal products by proposal ID","href":"/v3/dropship/api-reference/merchant/proposals/get-products-for-a-specific-proposal"},{"openapi":"dropship_proposals.openapi get /v1/retailers/{retailer_id}/proposals/{id}/approve/","title":"Approve a proposal","href":"/v3/dropship/api-reference/merchant/proposals/get-approved-proposals-by-id"},{"openapi":"dropship_proposals.openapi get /v1/rulesets/{ruleset_id}/proposals/products/","title":"Retrieve proposal products associated with a ruleset.","href":"/v3/dropship/api-reference/merchant/proposals/get-proposal-products-by-ruleset"},{"openapi":"dropship_proposals.openapi get /v1/rulesets/{ruleset_id}/proposals/{id}/proposal-products/","title":"Get a specific proposal product by ruleset","href":"/v3/dropship/api-reference/merchant/proposals/get-proposed-products-by-rule-and-id"},{"openapi":"dropship_proposals.openapi put /v1/retailers/{retailer_id}/proposals/{id}/complete/","title":"Mark a proposal as complete","href":"/v3/dropship/api-reference/merchant/proposals/mark-a-proposal-as-complete"}]},{"group":"Returns","pages":[{"openapi":"dropship_returns.openapi get /v1/retailers/{retailer_id}/rmas/","title":"Get a list of returns","href":"/v3/dropship/api-reference/merchant/returns/get-returns"},{"openapi":"dropship_returns.openapi get /v1/retailers/{retailer_id}/rmas/{id}/","title":"Get details of a return.","href":"/v3/dropship/api-reference/merchant/returns/get-return-by-id"},{"openapi":"dropship_returns.openapi post /v1/retailers/{retailer_id}/rmas/","title":"Register a pending return for a vendor","href":"/v3/dropship/api-reference/merchant/returns/create-a-return"},{"openapi":"dropship_returns.openapi put /v1/retailers/{retailer_id}/rmas/{id}/acknowledge/","title":"Acknowledge return","href":"/v3/dropship/api-reference/merchant/returns/acknowledge-return"}]},{"group":"Shipments","pages":[{"openapi":"dropship_shipments.openapi get /v1/retailers/{retailer_id}/shipments/","title":"List fulfillments or shipments from vendors","href":"/v3/dropship/api-reference/merchant/shipments/get-shipments"},{"openapi":"dropship_shipments.openapi get /v1/retailers/{retailer_id}/shipments/{id}/","title":"Get a single shipment","href":"/v3/dropship/api-reference/merchant/shipments/get-shipment-by-id"},{"openapi":"dropship_shipments.openapi get /v1/retailers/{retailer_id}/orders/{id}/shipments/","title":"Get shipments for an order","href":"/v3/dropship/api-reference/merchant/shipments/get-shipments-for-order"},{"openapi":"dropship_shipments.openapi put /v1/retailers/{retailer_id}/shipments/{id}/acknowledge/","title":"Acknowledge shipment receipt","href":"/v3/dropship/api-reference/merchant/shipments/acknowledge-shipment"}]},{"group":"Webhooks","pages":[{"openapi":"dropship_webhooks.openapi post /v1/retailers/{retailer_id}/webhooks/","title":"Subscribe to webhooks","href":"/v3/dropship/api-reference/merchant/webhooks/sub-to-a-webhook"}]}]},{"group":"Suppliers","pages":[{"title":"Overview","href":"/v3/dropship/dropship-suppliers/overview"},{"group":"Getting Started","pages":[{"title":"Supplier Onboarding Guide","href":"/v3/dropship/dropship-suppliers/getting-started/onboarding-guide"}]},{"group":"Integrations","pages":[{"title":"Introduction to Integrations","href":"/v3/dropship/dropship-suppliers/integrations/overview"},{"group":"Shopify","pages":[{"title":"Shopify Dropship Integration Overview","href":"/v3/dropship/dropship-suppliers/integrations/shopify-integration/shopify-dropship-integration-overview"},{"title":"Setting Up the Shopify Dropship Integration","href":"/v3/dropship/dropship-suppliers/integrations/shopify-integration/setting-up-shopify-dropship-integration"},{"title":"Resolving Shopify Sync Issues","href":"/v3/dropship/dropship-suppliers/integrations/shopify-integration/resolving-shopify-sync-issues"},{"title":"Monitoring Shopify Webhook Activity","href":"/v3/dropship/dropship-suppliers/integrations/shopify-integration/monitoring-shopify-webhook-activity"}]},{"title":"EDI and API Integrations","href":"/v3/dropship/dropship-suppliers/integrations/edi-api-integration"},{"title":"ShipStation Integration","href":"/v3/dropship/dropship-suppliers/integrations/shipstation-integration"},{"title":"WooCommerce Integration","href":"/v3/dropship/dropship-suppliers/integrations/woocommerce-integration"},{"title":"BigCommerce Integration","href":"/v3/dropship/dropship-suppliers/integrations/bigcommerce-integration"},{"title":"Console Integration","href":"/v3/dropship/dropship-suppliers/integrations/console-integration"},{"title":"FTP Integration","href":"/v3/dropship/dropship-suppliers/integrations/ftp-integration"}]},{"group":"Orders","pages":[{"title":"Overview","href":"/v3/dropship/dropship-suppliers/orders/overview"},{"group":"Fulfillments","pages":[{"title":"Adding Fulfillment Locations","href":"/v3/dropship/dropship-suppliers/orders/fulfillments/adding-fulfillment-locations"},{"title":"Registering/Importing Tracking","href":"/v3/dropship/dropship-suppliers/orders/fulfillments/registering-importing-tracking"},{"title":"Importing Tracking Numbers in Bulk","href":"/v3/dropship/dropship-suppliers/orders/fulfillments/importing-tracking-numbers-in-bulk"},{"title":"Generating and Reprinting Shipping Labels","sidebarTitle":" Generating Shipping Labels","href":"/v3/dropship/dropship-suppliers/orders/fulfillments/generating-shipping-labels"}]},{"group":"Submitting Invoices","pages":[{"title":"Importing Invoices","href":"/v3/dropship/dropship-suppliers/orders/submitting-invoices/importing-invoices"},{"title":"Registering Invoices","href":"/v3/dropship/dropship-suppliers/orders/submitting-invoices/registering-invoices"}]},{"group":"Reports","pages":[{"title":"Viewing Tracking Number Reports","href":"/v3/dropship/dropship-suppliers/orders/order-reports/tracking-number-reports"},{"title":"Viewing Invoice Reports","href":"/v3/dropship/dropship-suppliers/orders/order-reports/invoice-reports"},{"title":"Viewing Cancellation Reports","href":"/v3/dropship/dropship-suppliers/orders/order-reports/cancel-reports"},{"title":"Viewing Return Reports","href":"/v3/dropship/dropship-suppliers/orders/order-reports/return-reports"},{"title":"Viewing Credit Memo Reports","href":"/v3/dropship/dropship-suppliers/orders/order-reports/credit-memo-reports"}]},{"title":"Returns","href":"/v3/dropship/dropship-suppliers/orders/returns"},{"title":"Accepting/Declining Retailer Returns","href":"/v3/dropship/dropship-suppliers/orders/accepting-declining-returns"},{"title":"Cancelling Orders","href":"/v3/dropship/dropship-suppliers/orders/cancelling-orders"}]},{"group":"Products","pages":[{"title":"Overview","href":"/v3/dropship/dropship-suppliers/products/overview"},{"group":"Reviewing","pages":[{"title":"Updating Inventory","href":"/v3/dropship/dropship-suppliers/products/reviewing/updating-inventory"},{"title":"Inventory Policies","href":"/v3/dropship/dropship-suppliers/products/reviewing/inventory-policies"},{"title":"Reviewing Product Data","href":"/v3/dropship/dropship-suppliers/products/reviewing/reviewing-product-data"}]},{"group":"Merchandising","pages":[{"title":"Submitting a Product Proposal","href":"/v3/dropship/dropship-suppliers/products/merchandising/submitting-product-proposal"},{"title":"Reviewing Existing Proposals","href":"/v3/dropship/dropship-suppliers/products/merchandising/reviewing-existing-proposals"},{"title":"Accepting/Rejecting Import Requests","href":"/v3/dropship/dropship-suppliers/products/merchandising/accepting-rejecting-import-requests"},{"title":"How to Resolve Proposal Compatibility Issues","sidebarTitle":"Proposal Compatibility Issue FAQ","href":"/v3/dropship/dropship-suppliers/products/merchandising/proposal-compatibility-issues"},{"title":"Image Import Best Practices","href":"/v3/dropship/dropship-suppliers/products/merchandising/image-best-practices"}]},{"group":"Importing","pages":[{"title":"Importing Products from Shopify","href":"/v3/dropship/dropship-suppliers/products/importing/importing-from-shopify"},{"title":"Importing and Updating Products from a CSV","href":"/v3/dropship/dropship-suppliers/products/importing/importing-updating-products-from-csv"}]},{"group":"Catalog Utilities","pages":[{"title":"Importing offers","href":"/v3/dropship/dropship-suppliers/products/catalog-utilities/importing-offers"},{"title":"Revoking Permits","href":"/v3/dropship/dropship-suppliers/products/catalog-utilities/revoking-permits"},{"title":"Deleting SKUs","href":"/v3/dropship/dropship-suppliers/products/catalog-utilities/deleting-skus"}]}]},{"group":"Merchants","pages":[{"title":"Overview","href":"/v3/dropship/dropship-suppliers/merchants/overview"},{"title":"Viewing and Exporting Merchant Connections","href":"/v3/dropship/dropship-suppliers/merchants/exporting-merchant-connections"}]},{"group":"Reports","pages":[{"title":"Compliance Scorecard","sidebarTitle":"Compliance Scorecard","href":"/v3/dropship/dropship-suppliers/reports/compliance-scorecard"}]},{"group":"Settings","pages":[{"title":"Settings overview","sidebarTitle":"Overview","href":"/v3/dropship/dropship-suppliers/settings/overview"},{"title":"General information","href":"/v3/dropship/dropship-suppliers/settings/general-information"},{"title":"Currency Settings","href":"/v3/dropship/dropship-suppliers/settings/currency-settings"},{"title":"Notifications","href":"/v3/dropship/dropship-suppliers/settings/notifications"},{"title":"Branding","href":"/v3/dropship/dropship-suppliers/settings/branding"},{"title":"Inventory Settings","href":"/v3/dropship/dropship-suppliers/settings/inventory-settings"},{"title":"User Management","href":"/v3/dropship/dropship-suppliers/settings/user-management"},{"title":"API Clients","href":"/v3/dropship/dropship-suppliers/settings/api-clients"},{"title":"Integrations","href":"/v3/dropship/dropship-suppliers/settings/integrations"},{"group":"Integrations","pages":[{"group":"Shopify","pages":[{"title":"Configuration","href":"/v3/dropship/dropship-suppliers/settings/Integrations/Shopify/configuration"},{"title":"Webhook History","href":"/v3/dropship/dropship-suppliers/settings/Integrations/Shopify/webhook-history"},{"title":"Utilities","href":"/v3/dropship/dropship-suppliers/settings/Integrations/Shopify/utilities"}]},{"group":"BigCommerce","pages":[{"title":"Configuration","href":"/v3/dropship/dropship-suppliers/settings/Integrations/BigCommerce/configuration"},{"title":"Webhook History","href":"/v3/dropship/dropship-suppliers/settings/Integrations/BigCommerce/webhook-history"}]},{"group":"WooCommerce","pages":[{"title":"Configuration","href":"/v3/dropship/dropship-suppliers/settings/Integrations/WooCommerce/configuration"},{"title":"Webhook History","href":"/v3/dropship/dropship-suppliers/settings/Integrations/WooCommerce/webhook-history"}]},{"group":"ShipStation","pages":[{"title":"Configuration","href":"/v3/dropship/dropship-suppliers/settings/Integrations/ShipStation/configuration"},{"title":"Webhook History","href":"/v3/dropship/dropship-suppliers/settings/Integrations/ShipStation/webhook-history"},{"title":"Utilities","href":"/v3/dropship/dropship-suppliers/settings/Integrations/ShipStation/utilities"}]}]},{"title":"Webhooks (Advanced)","href":"/v3/dropship/dropship-suppliers/settings/webhooks-advanced"},{"title":"Attribute Value Transformers","href":"/v3/dropship/dropship-suppliers/settings/attribute-value-transformers"},{"title":"Product \u0026 Inventory Templates","href":"/v3/dropship/dropship-suppliers/settings/product-inventory-templates"},{"title":"Shipping Accounts","href":"/v3/dropship/dropship-suppliers/settings/shipping-accounts"},{"title":"Terms of Service","href":"/v3/dropship/dropship-suppliers/settings/terms-of-service"}]},{"title":"Checking Job Statuses","sidebarTitle":"Job Reports","href":"/v3/dropship/dropship-suppliers/checking-job-status"}]},{"group":"Supplier API Endpoints","pages":[{"title":"Authentication in Dropship","href":"/v3/dropship/api-reference/authentication"},{"group":"Connections","pages":[{"openapi":"connection_invites.openapi get /v1/brands/{brand_id}/connections/","title":"Get supplier connections","href":"/v3/dropship/api-reference/supplier/connections/get-connections"},{"openapi":"connection_invites.openapi get /v1/brands/{brand_id}/connections/{id}/","title":"Get supplier connection by ID","href":"/v3/dropship/api-reference/supplier/connections/get-connection-by-id"}]},{"group":"Inventory","pages":[{"openapi":"dropship_inventory.openapi get /v1/brands/{brand_id}/inventory/{id}/","title":"Get an inventory item","href":"/v3/dropship/api-reference/supplier/inventory/update-inventory"}]},{"group":"Orders","pages":[{"openapi":"dropship_orders.openapi put /v1/brands/{brand_id}/orders/{id}/acknowledge/","title":"Acknowledge an order by ID","href":"/v3/dropship/api-reference/supplier/orders/acknowledge-order"},{"openapi":"dropship_orders.openapi post /v1/brands/{brand_id}/orders/{id}/cancel/","title":"Cancel an Order","href":"/v3/dropship/api-reference/supplier/orders/cancel-order"}]},{"group":"Products","pages":[{"openapi":"dropship_products.openapi post /v1/brands/{brand_id}/products/{id}/variants/","title":"Create a product variant","href":"/v3/dropship/api-reference/supplier/products/create-variant"}]},{"group":"Proposals","pages":[{"openapi":"dropship_proposals.openapi get /v1/brands/{brand_id}/connections/{id}/departments/","title":"Get all proposal departments","href":"/v3/dropship/api-reference/supplier/proposals/get-proposals"},{"openapi":"dropship_proposals.openapi get /v1/brands/{brand_id}/connections/{id}/departments/{department_id}/","title":"Get a specific departments details","href":"/v3/dropship/api-reference/supplier/proposals/get-proposal-by-id"},{"openapi":"dropship_proposals.openapi post /v1/brands/{brand_id}/proposals/","title":"Create a Proposal","href":"/v3/dropship/api-reference/supplier/proposals/create-proposals"},{"openapi":"dropship_proposals.openapi post /v1/brands/{brand_id}/proposals/{id}/apply-transformer/","title":"Apply a transformer to a proposal","href":"/v3/dropship/api-reference/supplier/proposals/apply-transformer"},{"openapi":"dropship_proposals.openapi get /v1/brands/{brand_id}/proposals/{id}/compatibility-rulesets-failure-reports/","title":"Get a rulesets failure reports","href":"/v3/dropship/api-reference/supplier/proposals/get-compatibility-reports"},{"openapi":"dropship_proposals.openapi get /v1/rule-groups/?ruleset_id={ruleset_id}","title":"Get ruleset details","href":"/v3/dropship/api-reference/supplier/proposals/get-rulesets"},{"openapi":"dropship_proposals.openapi get /v1/brands/{brand_id}/proposals/{id}/rulesets-attributes-summary/","title":"Get a rulesets attribute summary","href":"/v3/dropship/api-reference/supplier/proposals/get-ruleset-attributes"},{"openapi":"dropship_proposals.openapi get /v1/brands/{brand_id}/proposals/{id}/rulesets-failure-summary/","title":"Get a rulesets failure summary","href":"/v3/dropship/api-reference/supplier/proposals/get-ruleset-failure-summary"}]},{"group":"Returns","pages":[{"openapi":"dropship_returns.openapi get /v1/brands/{brand_id}/rmas/","title":"Get a list of returns","href":"/v3/dropship/api-reference/supplier/returns/get-a-list-of-returns"},{"openapi":"dropship_returns.openapi get /v1/brands/{brand_id}/rmas/{id}/","title":"Get a specific return","href":"/v3/dropship/api-reference/supplier/returns/get-a-single-return"},{"openapi":"dropship_returns.openapi put /v1/brands/{brand_id}/rmas/{id}/approve/","title":"Approve a return","href":"/v3/dropship/api-reference/supplier/returns/approve-returns"},{"openapi":"dropship_returns.openapi put /v1/brands/{brand_id}/rmas/{id}/reject/","title":"Reject a return","href":"/v3/dropship/api-reference/supplier/returns/reject-returns"},{"group":"RMA Returns","pages":[{"openapi":"dropship_returns.openapi get /v1/brands/{brand_id}/rmas/{id}/returns/","title":"Get a list of RMA returns","href":"/v3/dropship/api-reference/supplier/returns/rma-returns/get-list-of-rma-returns"},{"openapi":"dropship_returns.openapi put /v1/brands/{brand_id}/rmas/{id}/returns/{return_id}/receive/","title":"Receive an RMA return","href":"/v3/dropship/api-reference/supplier/returns/rma-returns/mark-as-received"},{"openapi":"dropship_returns.openapi put /v1/brands/{brand_id}/rmas/{id}/returns/{return_id}/approve/","title":"Approve an RMA return","href":"/v3/dropship/api-reference/supplier/returns/rma-returns/mark-as-approved"},{"openapi":"dropship_returns.openapi put /v1/brands/{brand_id}/rmas/{id}/returns/{return_id}/reject/","title":"Reject an RMA return","href":"/v3/dropship/api-reference/supplier/returns/rma-returns/mark-as-rejected"}]}]},{"group":"Webhooks","pages":[{"openapi":"dropship_webhooks.openapi post /v1/brands/{brand_id}/webhooks/","title":"Subscribe to webhooks","href":"/v3/dropship/api-reference/supplier/webhooks/subscribe-to-webhook"}]}]}]},{"tab":"Cart \u0026 Checkout","pages":[{"title":"Cart \u0026 Checkout","href":"/v3/cart-and-checkout/api-reference/carts-v3/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/v3/integrations/overview"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/v3/platform/home/alerts/alerts-overview"}]},{"tab":"Store Fulfillment","pages":[{"title":"Store Fulfillment","href":"/v3/store-fulfillment/updating-store-location"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/v3/release-notes/july2025/release-summary"}]}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/home"}]}]},"basePath":"","title":"Acknowledge receipt of an invoice. - Fabric","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}