[{"data":1,"prerenderedAt":919},["ShallowReactive",2],{"navigation_docs":3,"-3pl-teams-manage-merchants":84,"-3pl-teams-manage-merchants-surround":914},[4,30,67],{"title":5,"path":6,"stem":7,"children":8,"page":29},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,17,21,25],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F2.authentication",{"title":18,"path":19,"stem":20},"Concepts","\u002Fgetting-started\u002Fconcepts","1.getting-started\u002F3.concepts",{"title":22,"path":23,"stem":24},"Order keys","\u002Fgetting-started\u002Forder-keys","1.getting-started\u002F4.order-keys",{"title":26,"path":27,"stem":28},"Errors and retries","\u002Fgetting-started\u002Ferrors-and-retries","1.getting-started\u002F5.errors-and-retries",false,{"title":31,"path":32,"stem":33,"children":34,"page":29},"API","\u002Fapi","2.api",[35,39,43,47,51,55,59,63],{"title":36,"path":37,"stem":38},"Create order","\u002Fapi\u002Fcreate-order","2.api\u002F1.create-order",{"title":40,"path":41,"stem":42},"Fetch order","\u002Fapi\u002Ffetch-order","2.api\u002F2.fetch-order",{"title":44,"path":45,"stem":46},"Fetch order status","\u002Fapi\u002Ffetch-order-status","2.api\u002F3.fetch-order-status",{"title":48,"path":49,"stem":50},"Fetch printers","\u002Fapi\u002Ffetch-printers","2.api\u002F4.fetch-printers",{"title":52,"path":53,"stem":54},"Print orders","\u002Fapi\u002Fprint-orders","2.api\u002F5.print-orders",{"title":56,"path":57,"stem":58},"Fetch order PDF","\u002Fapi\u002Ffetch-order-pdf","2.api\u002F6.fetch-order-pdf",{"title":60,"path":61,"stem":62},"Links","\u002Fapi\u002Flinks","2.api\u002F7.links",{"title":64,"path":65,"stem":66},"Validate source app credentials","\u002Fapi\u002Fvalidate-source-app-credentials","2.api\u002F8.validate-source-app-credentials",{"title":68,"path":69,"stem":70,"children":71,"page":29},"3PL teams","\u002F3pl-teams","3.3pl-teams",[72,76,80],{"title":73,"path":74,"stem":75},"Overview","\u002F3pl-teams\u002Foverview","3.3pl-teams\u002F1.overview",{"title":77,"path":78,"stem":79},"Manage merchant teams","\u002F3pl-teams\u002Fmanage-merchants","3.3pl-teams\u002F2.manage-merchants",{"title":81,"path":82,"stem":83},"Send orders to merchants","\u002F3pl-teams\u002Fsend-orders","3.3pl-teams\u002F3.send-orders",{"id":85,"title":77,"body":86,"description":907,"extension":908,"links":909,"meta":910,"navigation":911,"path":78,"seo":912,"stem":79,"__hash__":913},"docs\u002F3.3pl-teams\u002F2.manage-merchants.md",{"type":87,"value":88,"toc":899},"minimark",[89,93,98,115,118,382,392,396,405,458,504,514,647,656,660,669,699,708,712,715,724,731,740,771,778,782,785,794,804,807,811,895],[90,91,92],"p",{},"Use a parent 3PL API key for every request on this page.",[94,95,97],"h2",{"id":96},"list-merchants","List merchants",[99,100,105],"pre",{"className":101,"code":102,"language":103,"meta":104,"style":104},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET https:\u002F\u002Fapp.yuzu.so\u002Fapi\u002Fteams\u002Fmerchants\n","http","",[106,107,108],"code",{"__ignoreMap":104},[109,110,113],"span",{"class":111,"line":112},"line",1,[109,114,102],{},[90,116,117],{},"The response includes each merchant's lifecycle status, account manager, order count, and onboarding progress.",[99,119,123],{"className":120,"code":121,"language":122,"meta":104,"style":104},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","[\n  {\n    \"id\": \"org_exampleMerchant123456789\",\n    \"name\": \"Example Merchant\",\n    \"type\": \"merchant\",\n    \"parent_team_id\": \"org_exampleThreePl123456789\",\n    \"status\": \"onboarding\",\n    \"account_manager_user_id\": null,\n    \"orderCount\": 12,\n    \"onboarding\": {\n      \"total\": 5,\n      \"completed\": 3,\n      \"openThreePlTasks\": 1,\n      \"openMerchantTasks\": 1\n    }\n  }\n]\n","json",[106,124,125,131,137,165,186,207,228,249,264,282,296,315,332,349,364,370,376],{"__ignoreMap":104},[109,126,127],{"class":111,"line":112},[109,128,130],{"class":129},"sMK4o","[\n",[109,132,134],{"class":111,"line":133},2,[109,135,136],{"class":129},"  {\n",[109,138,140,143,147,150,153,156,160,162],{"class":111,"line":139},3,[109,141,142],{"class":129},"    \"",[109,144,146],{"class":145},"spNyl","id",[109,148,149],{"class":129},"\"",[109,151,152],{"class":129},":",[109,154,155],{"class":129}," \"",[109,157,159],{"class":158},"sfazB","org_exampleMerchant123456789",[109,161,149],{"class":129},[109,163,164],{"class":129},",\n",[109,166,168,170,173,175,177,179,182,184],{"class":111,"line":167},4,[109,169,142],{"class":129},[109,171,172],{"class":145},"name",[109,174,149],{"class":129},[109,176,152],{"class":129},[109,178,155],{"class":129},[109,180,181],{"class":158},"Example Merchant",[109,183,149],{"class":129},[109,185,164],{"class":129},[109,187,189,191,194,196,198,200,203,205],{"class":111,"line":188},5,[109,190,142],{"class":129},[109,192,193],{"class":145},"type",[109,195,149],{"class":129},[109,197,152],{"class":129},[109,199,155],{"class":129},[109,201,202],{"class":158},"merchant",[109,204,149],{"class":129},[109,206,164],{"class":129},[109,208,210,212,215,217,219,221,224,226],{"class":111,"line":209},6,[109,211,142],{"class":129},[109,213,214],{"class":145},"parent_team_id",[109,216,149],{"class":129},[109,218,152],{"class":129},[109,220,155],{"class":129},[109,222,223],{"class":158},"org_exampleThreePl123456789",[109,225,149],{"class":129},[109,227,164],{"class":129},[109,229,231,233,236,238,240,242,245,247],{"class":111,"line":230},7,[109,232,142],{"class":129},[109,234,235],{"class":145},"status",[109,237,149],{"class":129},[109,239,152],{"class":129},[109,241,155],{"class":129},[109,243,244],{"class":158},"onboarding",[109,246,149],{"class":129},[109,248,164],{"class":129},[109,250,252,254,257,259,261],{"class":111,"line":251},8,[109,253,142],{"class":129},[109,255,256],{"class":145},"account_manager_user_id",[109,258,149],{"class":129},[109,260,152],{"class":129},[109,262,263],{"class":129}," null,\n",[109,265,267,269,272,274,276,280],{"class":111,"line":266},9,[109,268,142],{"class":129},[109,270,271],{"class":145},"orderCount",[109,273,149],{"class":129},[109,275,152],{"class":129},[109,277,279],{"class":278},"sbssI"," 12",[109,281,164],{"class":129},[109,283,285,287,289,291,293],{"class":111,"line":284},10,[109,286,142],{"class":129},[109,288,244],{"class":145},[109,290,149],{"class":129},[109,292,152],{"class":129},[109,294,295],{"class":129}," {\n",[109,297,299,302,306,308,310,313],{"class":111,"line":298},11,[109,300,301],{"class":129},"      \"",[109,303,305],{"class":304},"sBMFI","total",[109,307,149],{"class":129},[109,309,152],{"class":129},[109,311,312],{"class":278}," 5",[109,314,164],{"class":129},[109,316,318,320,323,325,327,330],{"class":111,"line":317},12,[109,319,301],{"class":129},[109,321,322],{"class":304},"completed",[109,324,149],{"class":129},[109,326,152],{"class":129},[109,328,329],{"class":278}," 3",[109,331,164],{"class":129},[109,333,335,337,340,342,344,347],{"class":111,"line":334},13,[109,336,301],{"class":129},[109,338,339],{"class":304},"openThreePlTasks",[109,341,149],{"class":129},[109,343,152],{"class":129},[109,345,346],{"class":278}," 1",[109,348,164],{"class":129},[109,350,352,354,357,359,361],{"class":111,"line":351},14,[109,353,301],{"class":129},[109,355,356],{"class":304},"openMerchantTasks",[109,358,149],{"class":129},[109,360,152],{"class":129},[109,362,363],{"class":278}," 1\n",[109,365,367],{"class":111,"line":366},15,[109,368,369],{"class":129},"    }\n",[109,371,373],{"class":111,"line":372},16,[109,374,375],{"class":129},"  }\n",[109,377,379],{"class":111,"line":378},17,[109,380,381],{"class":129},"]\n",[90,383,384,385,387,388,391],{},"Store the merchant ",[106,386,146],{},". You use it as ",[106,389,390],{},"targetTeamId"," when creating orders.",[94,393,395],{"id":394},"create-a-merchant","Create a merchant",[99,397,399],{"className":101,"code":398,"language":103,"meta":104,"style":104},"POST https:\u002F\u002Fapp.yuzu.so\u002Fapi\u002Fteams\u002Fmerchants\n",[106,400,401],{"__ignoreMap":104},[109,402,403],{"class":111,"line":112},[109,404,398],{},[99,406,408],{"className":120,"code":407,"language":122,"meta":104,"style":104},"{\n  \"name\": \"Example Merchant\",\n  \"email\": \"operations@example.com\"\n}\n",[106,409,410,415,434,453],{"__ignoreMap":104},[109,411,412],{"class":111,"line":112},[109,413,414],{"class":129},"{\n",[109,416,417,420,422,424,426,428,430,432],{"class":111,"line":133},[109,418,419],{"class":129},"  \"",[109,421,172],{"class":145},[109,423,149],{"class":129},[109,425,152],{"class":129},[109,427,155],{"class":129},[109,429,181],{"class":158},[109,431,149],{"class":129},[109,433,164],{"class":129},[109,435,436,438,441,443,445,447,450],{"class":111,"line":139},[109,437,419],{"class":129},[109,439,440],{"class":145},"email",[109,442,149],{"class":129},[109,444,152],{"class":129},[109,446,155],{"class":129},[109,448,449],{"class":158},"operations@example.com",[109,451,452],{"class":129},"\"\n",[109,454,455],{"class":111,"line":167},[109,456,457],{"class":129},"}\n",[459,460,461,477],"table",{},[462,463,464],"thead",{},[465,466,467,471,474],"tr",{},[468,469,470],"th",{},"Field",[468,472,473],{},"Type",[468,475,476],{},"Description",[478,479,480,493],"tbody",{},[465,481,482,487,490],{},[483,484,485],"td",{},[106,486,172],{},[483,488,489],{},"string",[483,491,492],{},"Required. Merchant-team name, up to 100 characters.",[465,494,495,499,501],{},[483,496,497],{},[106,498,440],{},[483,500,489],{},[483,502,503],{},"Optional. Invites this address as a merchant-team admin.",[90,505,506,507,509,510,513],{},"Yuzu creates the merchant in ",[106,508,244],{},", seeds its onboarding tracker and default order flow, and adds the parent team's admins to the merchant team. A successful request returns ",[106,511,512],{},"201 Created",".",[99,515,517],{"className":120,"code":516,"language":122,"meta":104,"style":104},"{\n  \"team\": {\n    \"id\": \"org_exampleMerchant123456789\",\n    \"name\": \"Example Merchant\",\n    \"type\": \"merchant\",\n    \"parent_team_id\": \"org_exampleThreePl123456789\",\n    \"status\": \"onboarding\"\n  },\n  \"invitationSent\": true\n}\n",[106,518,519,523,536,554,572,590,608,624,629,643],{"__ignoreMap":104},[109,520,521],{"class":111,"line":112},[109,522,414],{"class":129},[109,524,525,527,530,532,534],{"class":111,"line":133},[109,526,419],{"class":129},[109,528,529],{"class":145},"team",[109,531,149],{"class":129},[109,533,152],{"class":129},[109,535,295],{"class":129},[109,537,538,540,542,544,546,548,550,552],{"class":111,"line":139},[109,539,142],{"class":129},[109,541,146],{"class":304},[109,543,149],{"class":129},[109,545,152],{"class":129},[109,547,155],{"class":129},[109,549,159],{"class":158},[109,551,149],{"class":129},[109,553,164],{"class":129},[109,555,556,558,560,562,564,566,568,570],{"class":111,"line":167},[109,557,142],{"class":129},[109,559,172],{"class":304},[109,561,149],{"class":129},[109,563,152],{"class":129},[109,565,155],{"class":129},[109,567,181],{"class":158},[109,569,149],{"class":129},[109,571,164],{"class":129},[109,573,574,576,578,580,582,584,586,588],{"class":111,"line":188},[109,575,142],{"class":129},[109,577,193],{"class":304},[109,579,149],{"class":129},[109,581,152],{"class":129},[109,583,155],{"class":129},[109,585,202],{"class":158},[109,587,149],{"class":129},[109,589,164],{"class":129},[109,591,592,594,596,598,600,602,604,606],{"class":111,"line":209},[109,593,142],{"class":129},[109,595,214],{"class":304},[109,597,149],{"class":129},[109,599,152],{"class":129},[109,601,155],{"class":129},[109,603,223],{"class":158},[109,605,149],{"class":129},[109,607,164],{"class":129},[109,609,610,612,614,616,618,620,622],{"class":111,"line":230},[109,611,142],{"class":129},[109,613,235],{"class":304},[109,615,149],{"class":129},[109,617,152],{"class":129},[109,619,155],{"class":129},[109,621,244],{"class":158},[109,623,452],{"class":129},[109,625,626],{"class":111,"line":251},[109,627,628],{"class":129},"  },\n",[109,630,631,633,636,638,640],{"class":111,"line":266},[109,632,419],{"class":129},[109,634,635],{"class":145},"invitationSent",[109,637,149],{"class":129},[109,639,152],{"class":129},[109,641,642],{"class":129}," true\n",[109,644,645],{"class":111,"line":284},[109,646,457],{"class":129},[90,648,649,651,652,655],{},[106,650,635],{}," can be ",[106,653,654],{},"false"," even when the team was created. Check it before telling the merchant that an invitation was sent.",[94,657,659],{"id":658},"invite-another-merchant-admin","Invite another merchant admin",[99,661,663],{"className":101,"code":662,"language":103,"meta":104,"style":104},"POST https:\u002F\u002Fapp.yuzu.so\u002Fapi\u002Fteams\u002Fmerchants\u002F{merchantTeamId}\u002Finvitations\n",[106,664,665],{"__ignoreMap":104},[109,666,667],{"class":111,"line":112},[109,668,662],{},[99,670,672],{"className":120,"code":671,"language":122,"meta":104,"style":104},"{\n  \"email\": \"another.user@example.com\"\n}\n",[106,673,674,678,695],{"__ignoreMap":104},[109,675,676],{"class":111,"line":112},[109,677,414],{"class":129},[109,679,680,682,684,686,688,690,693],{"class":111,"line":133},[109,681,419],{"class":129},[109,683,440],{"class":145},[109,685,149],{"class":129},[109,687,152],{"class":129},[109,689,155],{"class":129},[109,691,692],{"class":158},"another.user@example.com",[109,694,452],{"class":129},[109,696,697],{"class":111,"line":139},[109,698,457],{"class":129},[90,700,701,702,704,705,513],{},"The invited user joins the merchant team as an administrator. Successful requests return ",[106,703,512],{}," with ",[106,706,707],{},"{ \"invitationSent\": true }",[94,709,711],{"id":710},"assign-an-account-manager","Assign an account manager",[90,713,714],{},"First list the parent 3PL team's members:",[99,716,718],{"className":101,"code":717,"language":103,"meta":104,"style":104},"GET https:\u002F\u002Fapp.yuzu.so\u002Fapi\u002Fteams\u002Fmembers\n",[106,719,720],{"__ignoreMap":104},[109,721,722],{"class":111,"line":112},[109,723,717],{},[90,725,726,727,730],{},"Use the selected member's ",[106,728,729],{},"userId"," when updating the merchant:",[99,732,734],{"className":101,"code":733,"language":103,"meta":104,"style":104},"PUT https:\u002F\u002Fapp.yuzu.so\u002Fapi\u002Fteams\u002Fmerchants\u002F{merchantTeamId}\n",[106,735,736],{"__ignoreMap":104},[109,737,738],{"class":111,"line":112},[109,739,733],{},[99,741,743],{"className":120,"code":742,"language":122,"meta":104,"style":104},"{\n  \"accountManagerUserId\": \"user_example123\"\n}\n",[106,744,745,749,767],{"__ignoreMap":104},[109,746,747],{"class":111,"line":112},[109,748,414],{"class":129},[109,750,751,753,756,758,760,762,765],{"class":111,"line":133},[109,752,419],{"class":129},[109,754,755],{"class":145},"accountManagerUserId",[109,757,149],{"class":129},[109,759,152],{"class":129},[109,761,155],{"class":129},[109,763,764],{"class":158},"user_example123",[109,766,452],{"class":129},[109,768,769],{"class":111,"line":139},[109,770,457],{"class":129},[90,772,773,774,777],{},"The account manager must belong to the parent 3PL team. Send ",[106,775,776],{},"null"," to clear the assignment.",[94,779,781],{"id":780},"take-a-merchant-live","Take a merchant live",[90,783,784],{},"Take the merchant live after the onboarding tracker is complete and the test print has passed.",[99,786,788],{"className":101,"code":787,"language":103,"meta":104,"style":104},"POST https:\u002F\u002Fapp.yuzu.so\u002Fapi\u002Fteams\u002Fmerchants\u002F{merchantTeamId}\u002Fgo-live\n",[106,789,790],{"__ignoreMap":104},[109,791,792],{"class":111,"line":112},[109,793,787],{},[90,795,796,797,800,801,513],{},"The operation is idempotent. Its response contains the updated team, including ",[106,798,799],{},"went_live_at"," and ",[106,802,803],{},"went_live_by",[90,805,806],{},"Go-live enables automatic printing for new eligible orders. It does not automatically print orders received during onboarding; review and print those orders manually if required.",[94,808,810],{"id":809},"status-codes","Status codes",[459,812,813,823],{},[462,814,815],{},[465,816,817,820],{},[468,818,819],{},"Status",[468,821,822],{},"Meaning",[478,824,825,835,845,855,865,875,885],{},[465,826,827,832],{},[483,828,829],{},[106,830,831],{},"200",[483,833,834],{},"List, update, or go-live request succeeded.",[465,836,837,842],{},[483,838,839],{},[106,840,841],{},"201",[483,843,844],{},"Merchant creation or invitation succeeded.",[465,846,847,852],{},[483,848,849],{},[106,850,851],{},"400",[483,853,854],{},"Invalid request data or account-manager assignment.",[465,856,857,862],{},[483,858,859],{},[106,860,861],{},"401",[483,863,864],{},"Missing, malformed, or invalid API key.",[465,866,867,872],{},[483,868,869],{},[106,870,871],{},"403",[483,873,874],{},"The authenticated team is not a 3PL team.",[465,876,877,882],{},[483,878,879],{},[106,880,881],{},"404",[483,883,884],{},"The merchant is not managed by the authenticated 3PL team.",[465,886,887,892],{},[483,888,889],{},[106,890,891],{},"5xx",[483,893,894],{},"Yuzu could not complete the operation.",[896,897,898],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}",{"title":104,"searchDepth":133,"depth":133,"links":900},[901,902,903,904,905,906],{"id":96,"depth":133,"text":97},{"id":394,"depth":133,"text":395},{"id":658,"depth":133,"text":659},{"id":710,"depth":133,"text":711},{"id":780,"depth":133,"text":781},{"id":809,"depth":133,"text":810},"Create managed merchants, invite their users, assign account managers, and go live.","md",null,{},true,{"title":77,"description":907},"_oyAYh_zQ9RnUZq-kx1gn207qHDhJ2Rn5K3ddaKd910",[915,917],{"title":73,"path":74,"stem":75,"description":916,"children":-1},"Manage merchant teams and their orders with one 3PL API key.",{"title":81,"path":82,"stem":83,"description":918,"children":-1},"Target managed merchants while using the shared Yuzu order APIs.",1786713552752]