{"items":[{"type":"link","label":"Overview","link":"/openapi/location","routeSlug":"/openapi/location","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"location.json","url":"/_bundle/openapi/location.json?download"},{"kind":"download","label":"location.yaml","url":"/_bundle/openapi/location.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/locationmgmt","description":"Sandbox Server for Location Management API"},{"url":"https://api.sendpro360.pitneybowes.com/locationmgmt","description":"Production Server for Location Management (uses live data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Overview (0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations are subsets of divisions, which are subsets of your enterprise. Each division can contain multiple locations. At least one division must already exist in order to create a location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Divisions and locations allow you to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign users to a specific location"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Give users permission to perform admin tasks for specific divisions or locations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign different carrier accounts to certain divisions or locations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow cost accounts to be used by only specified divisions or locations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View reporting data for individual divisions or locations (requires Analytics subscription)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Give users permission to view reporting data for specific divisions or locations (requires Analytics subscription)"},"children":[]}]}]}]}]}],"sectionId":"/openapi/location"}],"sectionId":"/openapi/location"}]}]}},{"type":"group","label":"Location Management","link":"/openapi/location/location-management","routeSlug":"/openapi/location/location-management","items":[{"label":"Get Divisions Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/location/location-management/getdivisions","routeSlug":"/openapi/location/location-management/getdivisions","metadata":{"seo":{"title":"Get Divisions Details","description":"This operation provides the divisions details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDivisions","name":"Get Divisions Details","isWebhook":false,"pointer":"/paths/~1api~1v1~1divisions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Divisions Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation provides the divisions details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_269","description":"page number"},{"name":"size","in":"query","schemaId":"schema_269","description":"size of records"}],"pointer":"/paths/~1api~1v1~1divisions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_270"}],"pointer":"/paths/~1api~1v1~1divisions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/divisions","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/locationmgmt","description":"Sandbox Server for Location Management API"},{"url":"https://api.sendpro360.pitneybowes.com/locationmgmt","description":"Production Server for Location Management (uses live data)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_269"},{"name":"size","in":"query","required":false,"schemaId":"schema_269"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_270"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","5XX"],"pointer":"/api/v1/divisions","href":"location-management/getdivisions","openApiOperationId":"getDivisions","summary":"Get Divisions Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/locationmgmt","description":"Sandbox Server for Location Management API"},{"url":"https://api.sendpro360.pitneybowes.com/locationmgmt","description":"Production Server for Location Management (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":"Divisions Get Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDivisionsResponse"}},"schemaId":"components/schemas/GetDivisionsResponse"},{"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":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrors"}},"schemaId":"components/schemas/NotFoundErrors"},{"code":"5XX","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1divisions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDivisionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDivisionsResponse"}}},{"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":"404","schemaId":"components/schemas/NotFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrors"}}},{"code":"5XX"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-management/getdivisions"}],"panels":[]}]},"httpPath":"/api/v1/divisions"},{"label":"Get Locations Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/location/location-management/getlocations","routeSlug":"/openapi/location/location-management/getlocations","metadata":{"seo":{"title":"Get Locations Details","description":"This operation provides the location details with the subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocations","name":"Get Locations Details","isWebhook":false,"pointer":"/paths/~1api~1v1~1locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Locations Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation provides the location details with the subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"divisionID","in":"query","schemaId":"schema_270","description":"It specifies the division id. If provided it will only show the location details under this division."},{"name":"page","in":"query","schemaId":"schema_269","description":"page number"},{"name":"size","in":"query","schemaId":"schema_269","description":"size of records"}],"pointer":"/paths/~1api~1v1~1locations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_270"}],"pointer":"/paths/~1api~1v1~1locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/locations","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/locationmgmt","description":"Sandbox Server for Location Management API"},{"url":"https://api.sendpro360.pitneybowes.com/locationmgmt","description":"Production Server for Location Management (uses live data)"}],"parameters":{"path":[],"query":[{"name":"divisionID","in":"query","required":false,"schemaId":"schema_270"},{"name":"page","in":"query","required":false,"schemaId":"schema_269"},{"name":"size","in":"query","required":false,"schemaId":"schema_269"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_270"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","5XX"],"pointer":"/api/v1/locations","href":"location-management/getlocations","openApiOperationId":"getLocations","summary":"Get Locations Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/locationmgmt","description":"Sandbox Server for Location Management API"},{"url":"https://api.sendpro360.pitneybowes.com/locationmgmt","description":"Production Server for Location Management (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":"Locations Get Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetLocationsResponse"}},"schemaId":"components/schemas/GetLocationsResponse"},{"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":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrors"}},"schemaId":"components/schemas/NotFoundErrors"},{"code":"5XX","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetLocationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetLocationsResponse"}}},{"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":"404","schemaId":"components/schemas/NotFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrors"}}},{"code":"5XX"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-management/getlocations"}],"panels":[]}]},"httpPath":"/api/v1/locations"}],"content":{"contentType":"group","meta":{"name":"Location Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Management","showPageActions":true},{"nodeType":"markdoc","content":"APIs return the details of divisions and locations associated with the developer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/divisions","summary":"Get Divisions Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-management/getdivisions","deprecated":false},{"title":"/api/v1/locations","summary":"Get Locations Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-management/getlocations","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/GetLocationsResponse":{"id":"components/schemas/GetLocationsResponse","kind":"json-schema","title":"GetLocationsResponse","data":{"type":"object","properties":{"pageInfo":{"type":"object","description":"Pagination details","properties":{"total":{"type":"number","description":"Total number records displayed","example":1},"pages":{"type":"number","description":"Total pages","example":1},"page":{"type":"number","description":"current page","example":10}}},"data":{"type":"object","description":"Unique identifier of the account","properties":{"locationID":{"type":"string","description":"This defines location id","example":"4a0e2Bb4Njw"},"customerLocationId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a customer-defined location identifier in addition to the system-generated LocationId created during developer onboarding. If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerLocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not defined, the system assigns a default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In responses, both identifiers are returned, if a customer-defined value is not set, both fields return the same system-generated LocationID"},"children":[]}]}]}],"example":"4a0e2Bb4Njw","type":"string"},"divisionID":{"type":"string","description":"This defines division id","example":"4a0e2Bbshdh"},"accountNumber":{"type":"string","description":"This defines account number","example":"1242"},"name":{"type":"string","description":"This defines name of the customer","example":"John"},"company":{"type":"string","description":"This defines company name","example":"PB"},"addressLine1":{"type":"string","description":"This defines address of customer","example":"203, new york"},"city":{"type":"string","description":"This defines city","example":"New York"},"state":{"type":"string","description":"This defines state","example":"NY"},"postalCode":{"type":"string","description":"This defines postal code","example":"10001"},"countryCode":{"type":"string","description":"This defines country code","example":"US"},"phone":{"type":"string","description":"This defines phone number","example":"826482849"},"isReturnAddressSame":{"type":"boolean","description":"This defines if return address is or not","example":false},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Alternate return address will be returned in the response only if it is present in the location."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}}}}}}},"components/schemas/GetDivisionsResponse":{"id":"components/schemas/GetDivisionsResponse","kind":"json-schema","title":"GetDivisionsResponse","data":{"type":"object","properties":{"pageInfo":{"type":"object","description":"Pagination details","properties":{"total":{"type":"number","description":"Total number records displayed","example":1},"pages":{"type":"number","description":"Total pages","example":1},"page":{"type":"number","description":"current page","example":10}}},"data":{"type":"object","description":"array of divisions","properties":{"divisionID":{"type":"string","description":"This defines division id","example":"4a0e2Bb4Njw"},"name":{"type":"string","description":"This defines name of the division","example":"UK"}}}}}},"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":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.","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)."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 1101055, 0100008, or 1021126."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/NotFoundErrors":{"id":"components/schemas/NotFoundErrors","kind":"json-schema","title":"NotFoundErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found","description":"Error code(s) that appear due HTTP 404 Page or File not found."},"errorDescription":{"type":"string","example":"resource not found","description":"The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 0100025, 1110017, or 1090001."},"additionalInfo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. This error 'Not Found' might appear due to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Shipments to close"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Original Transaction not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"schema_269":{"kind":"json-schema","data":{"type":"number"},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"string"},"id":"schema_270"}},"exampleStore":{},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/locationmgmt","description":"Sandbox Server for Location Management API"},{"url":"https://api.sendpro360.pitneybowes.com/locationmgmt","description":"Production Server for Location Management (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/location.json?download"},{"url":"/_bundle/openapi/location.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview","description":"Locations are subsets of divisions, which are subsets of your enterprise. Each division can contain multiple locations. At least one division must already exist in order to create a location.\n\n**Divisions and locations allow you to:**\n\n- Assign users to a specific location\n- Give users permission to perform admin tasks for specific divisions or locations\n- Assign different carrier accounts to certain divisions or locations\n- Allow cost accounts to be used by only specified divisions or locations\n- View reporting data for individual divisions or locations (requires Analytics subscription)\n- Give users permission to view reporting data for specific divisions or locations (requires Analytics subscription)\n"}},"baseSlug":"/openapi/location","routesMapping":{}}