{"items":[{"type":"link","label":"Merchants APIs","link":"/openapi/merchants","routeSlug":"/openapi/merchants","content":{"contentType":"overview","meta":{"name":"Merchants APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"merchants.json","url":"/_bundle/openapi/merchants.json?download"},{"kind":"download","label":"merchants.yaml","url":"/_bundle/openapi/merchants.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Merchants APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Partner APIs provide operations to retrieve and manage partner entities associated with a developer account. Partners include individual merchants and known shippers that are onboarded and linked to the developer for shipping and business operations.\n\nThese APIs enable retrieval of partner information based on type and status, supporting visibility into all associated business partners under a developer account."}],"sectionId":"/openapi/merchants"}],"sectionId":"/openapi/merchants"}]}]}},{"type":"group","label":"Partners","link":"/openapi/merchants/partners","routeSlug":"/openapi/merchants/partners","items":[{"label":"Get All Partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/merchants/partners/getallpartners","routeSlug":"/openapi/merchants/partners/getallpartners","metadata":{"seo":{"title":"Get All Partners","description":"The operation fetches all partners (merchants and knownshippers) associated to a developer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getallPartners","name":"Get All Partners","isWebhook":false,"pointer":"/paths/~1api~1v1~1partners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Partners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation fetches all partners (merchants and knownshippers) associated to a developer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_290"},{"name":"status","in":"query","schemaId":"schema_291"}],"pointer":"/paths/~1api~1v1~1partners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/partners","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":false,"schemaId":"schema_290"},{"name":"status","in":"query","required":false,"schemaId":"schema_291"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/partners","href":"partners/getallpartners","openApiOperationId":"getallPartners","summary":"Get All Partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The associated partners have been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllPartners"}},"schemaId":"components/schemas/GetAllPartners"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1partners/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAllPartners","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllPartners"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/getallpartners"}],"panels":[]}]},"httpPath":"/api/v1/partners"},{"label":"Get Individual Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/merchants/partners/getpartner","routeSlug":"/openapi/merchants/partners/getpartner","metadata":{"seo":{"title":"Get Individual Merchant","description":"The operation fetches individual merchants associated to a developer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPartner","name":"Get Individual Merchant","isWebhook":false,"pointer":"/paths/~1api~1v1~1partners~1individual/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Individual Merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation fetches individual merchants associated to a developer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_292"}],"pointer":"/paths/~1api~1v1~1partners~1individual/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/partners/individual","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_292"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/partners/individual","href":"partners/getpartner","openApiOperationId":"getPartner","summary":"Get Individual Merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The specified partner has been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIndividualMerchant"}},"schemaId":"components/schemas/GetIndividualMerchant"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1partners~1individual/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetIndividualMerchant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIndividualMerchant"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/getpartner"}],"panels":[]}]},"httpPath":"/api/v1/partners/individual"}],"content":{"contentType":"group","meta":{"name":"Partners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partners","showPageActions":true},{"nodeType":"markdoc","content":"APIs for retrieving partner entities associated with a developer account. These APIs support operations such as fetching all partners, filtering partners by type and status, and retrieving details of individual merchants using a partner identifier. They enable visibility and management of business partners involved in shipping workflows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/partners","summary":"Get All Partners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/getallpartners","deprecated":false},{"title":"/api/v1/partners/individual","summary":"Get Individual Merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/getpartner","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource."}},"required":["message"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors.","items":{"type":"object","properties":{"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This error can be validation_error or internal_error or not_found or already_exists"},"children":[]}]}]}],"example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Custom Product not found"}}}}}}},"components/schemas/GetAllPartners":{"id":"components/schemas/GetAllPartners","kind":"json-schema","title":"GetAllPartners","data":{"type":"object","description":"Response including associated merchants and known shippers for the developer.","properties":{"data":{"type":"array","description":"List of merchant/known-shipper records.","items":{"$ref":"#/components/schemas/MerchantDirectoryRecord"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}}},"components/schemas/GetPartner":{"id":"components/schemas/GetPartner","kind":"json-schema","title":"GetPartner","data":{"type":"object","description":"Response including associated merchants and known shippers for the developer.","properties":{"data":{"type":"array","description":"Individual Partner records.","items":{"$ref":"#/components/schemas/MerchantDirectoryRecord"}}}}},"components/schemas/GetIndividualMerchant":{"id":"components/schemas/GetIndividualMerchant","kind":"json-schema","title":"GetIndividualMerchant","data":{"type":"object","description":"Response including associated merchant for the developer.","properties":{"subId":{"type":"string","description":"For Individual Merchants it is merchant's subscription ID. This returns in the response only if the partner is Individual Merchant."},"type":{"type":"string","description":"Type of the developer partner. Here type in individual merchant.","example":"Individual Merchant"},"archive":{"type":"boolean","description":"Indicates if the record is archived.","example":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the merchant. Status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when partner is deleted from UI and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMINATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when partner is deleted via API."},"children":[]}]}]}],"enum":["ACTIVE","SUSPENDED","TERMINATED"],"example":"TERMINATED"},"insertTimestamp":{"type":"string","format":"date-time","description":"Creation timestamp for this association.","example":"2025-10-09T14:18:17.9Z"},"updateTimestamp":{"type":"string","format":"date-time","description":"Last update timestamp for this association.","example":"2025-10-09T14:18:30.142Z"},"developerId":{"type":"string","description":"Developer/partner identifier that owns this association.","example":"sa535e3"},"email":{"type":"string","format":"email","description":"Contact email for the merchant.","example":"abcd_1@yopmail.com"},"name":{"type":"string","description":"Display name for the merchant.","example":"Known Merchant1"},"countryCode":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code.","example":"US"},"carrierAccounts":{"type":"array","description":"Carriers accounts details associated with this merchant.","items":{"type":"object","properties":{"carrierAccountId":{"type":"string","description":"Carrier account identifier.","example":"9RNmJJnM5x1Y"},"carrierName":{"type":"string","description":"Name of the carrier.","example":"DHL Express"},"carrierID":{"type":"string","description":"Carrier identifier.","example":"DHLEXP"},"shipperId":{"type":"string","description":"ShipperId  of the merchant.","example":"2000082819"}}}}}}},"components/schemas/MerchantDirectoryRecord":{"id":"components/schemas/MerchantDirectoryRecord","kind":"json-schema","title":"MerchantDirectoryRecord","data":{"type":"object","description":"A merchant or known-shipper record associated with the specified developer.\n","properties":{"shipperId":{"type":"string","description":"ShipperId  of the known shipper. This returns in the response only if the partner is Know Shipper.","example":"2000099528"},"subId":{"type":"string","description":"For Individual Merchants it is merchant's subscription ID. This returns in the response only if the partner is Individual Merchant."},"type":{"type":"string","description":"Record type (merchant vs. known-shipper).","enum":["Individual Merchant","Known Shipper"],"example":"Known Shipper"},"archive":{"type":"boolean","description":"Indicates if the record is archived.","example":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the merchant/known shipper. Status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when partner is deleted from UI and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMINATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when partner is deleted via API."},"children":[]}]}]}],"enum":["ACTIVE","SUSPENDED","TERMINATED"],"example":"TERMINATED"},"insertTimestamp":{"type":"string","format":"date-time","description":"Creation timestamp for this association.","example":"2025-10-09T14:18:17.9Z"},"updateTimestamp":{"type":"string","format":"date-time","description":"Last update timestamp for this association.","example":"2025-10-09T14:18:30.142Z"},"developerId":{"type":"string","description":"Developer/partner identifier that owns this association.","example":"sa535e3"},"email":{"type":"string","format":"email","description":"Contact email for the merchant/known shipper.","example":"abcd_1@yopmail.com"},"name":{"type":"string","description":"Display name for the merchant/known shipper.","example":"Known Merchant1"},"countryCode":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code.","example":"US"}}}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","description":"Pagination summary for the result set.","properties":{"totalCount":{"type":"integer","description":"Total number of records matching the query.","example":3},"startCount":{"type":"integer","description":"1-based index of the first record returned in this page.","example":1},"limit":{"type":"integer","description":"Maximum number of records requested per page.","example":10}}}},"schema_290":{"kind":"json-schema","data":{"type":"string","description":"Known Shipper and Individual Merchant"},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"type":"string","description":"ACTIVE, SUSPENDED and TERMINATED"},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"type":"string","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. Here individual merchant is the business partner."},"id":"schema_292"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/merchants.json?download"},{"url":"/_bundle/openapi/merchants.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Merchants APIs","description":"The Partner APIs provide operations to retrieve and manage partner entities associated with a developer account. Partners include individual merchants and known shippers that are onboarded and linked to the developer for shipping and business operations.\n\nThese APIs enable retrieval of partner information based on type and status, supporting visibility into all associated business partners under a developer account.\n"}},"baseSlug":"/openapi/merchants","routesMapping":{}}