{"items":[{"type":"link","label":"Importer of Record API","link":"/openapi/importerofrecord","routeSlug":"/openapi/importerofrecord","content":{"contentType":"overview","meta":{"name":"Importer of Record API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"importerofrecord.json","url":"/_bundle/openapi/importerofrecord.json?download"},{"kind":"download","label":"importerofrecord.yaml","url":"/_bundle/openapi/importerofrecord.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"PB Software License Agreement","url":"https://www.pitneybowes.com/us/support/account/pitney-bowes-terms-and-conditions.html"}]},{"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Importer of Record API (1.0.0)","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":"Manage "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importer of Record (IOR)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries that represent legal entities responsible"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for ensuring compliance of imported goods with local customs regulations, including"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filing declarations and paying duties/taxes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These APIs 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":"Create an Importer of Record definition with a unique code and associated country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an Importer of Record by its unique identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lookup and filter Importers of Record by metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update or partially update Importer of Record details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete Importers of Record no longer in use."},"children":[]}]}]}]}]}],"sectionId":"/openapi/importerofrecord"}],"sectionId":"/openapi/importerofrecord"}]}]}},{"type":"group","label":"Importer of Record","link":"/openapi/importerofrecord/importer-of-record","routeSlug":"/openapi/importerofrecord/importer-of-record","items":[{"label":"Create Importer of Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/createimporterofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/createimporterofrecord","metadata":{"seo":{"title":"Create Importer of Record","description":"Creates a new Importer of Record entry for a specific country.Each entry must have a unique iorCode and is tied to a countryCode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createImporterOfRecord","name":"Create Importer of Record","isWebhook":false,"pointer":"/paths/~1api~1v1~1importerofrecord/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Importer of Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Importer of Record entry for a specific country."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each entry must have a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is tied to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordCreate"}},"schemaId":"components/schemas/ImporterOfRecordCreate","pointer":"/paths/~1api~1v1~1importerofrecord/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/importerofrecord","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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordCreate"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/importerofrecord","href":"importer-of-record/createimporterofrecord","openApiOperationId":"createImporterOfRecord","summary":"Create Importer of Record"},"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/ImporterOfRecordCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Importer of Record successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordCreated"}},"schemaId":"components/schemas/ImporterOfRecordCreated"},{"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~1importerofrecord/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImporterOfRecordCreated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordCreated"}}},{"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":"/importer-of-record/createimporterofrecord"}],"panels":[]}]},"httpPath":"/api/v1/importerofrecord"},{"label":"Get Importers of Record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/getimportersofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/getimportersofrecord","metadata":{"seo":{"title":"Get Importers of Record","description":"Returns a list of Importers of Record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getImportersOfRecord","name":"Get Importers of Record","isWebhook":false,"pointer":"/paths/~1api~1v1~1importerofrecord/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Importers of Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of Importers of Record.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort expression in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<field>,<direction>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insertTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insertTimestamp,DESC"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1importerofrecord/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/importerofrecord","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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","example":"insertTimestamp,DESC","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/importerofrecord","href":"importer-of-record/getimportersofrecord","openApiOperationId":"getImportersOfRecord","summary":"Get Importers of Record"},"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of importers of record has beed retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1"},{"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~1importerofrecord/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}}},{"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":"/importer-of-record/getimportersofrecord"}],"panels":[]}]},"httpPath":"/api/v1/importerofrecord"},{"label":"Get Importer of Record by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/getimporterofrecordbyid","routeSlug":"/openapi/importerofrecord/importer-of-record/getimporterofrecordbyid","metadata":{"seo":{"title":"Get Importer of Record by ID","description":"Retrieves a specific Importer of Record entry by its unique id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getImporterofRecordByID","name":"Get Importer of Record by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Importer of Record by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a specific Importer of Record entry by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Unique identifier of the Importer of Record entry.","required":true}],"pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/importerofrecord/{id}","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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/importerofrecord/{id}","href":"importer-of-record/getimporterofrecordbyid","openApiOperationId":"getImporterofRecordByID","summary":"Get Importer of Record by ID"},"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified importer of record has beed retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImporterOfRecord"}},"schemaId":"components/schemas/ImporterOfRecord"},{"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~1importerofrecord~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImporterOfRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImporterOfRecord"}}},{"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":"/importer-of-record/getimporterofrecordbyid"}],"panels":[]}]},"httpPath":"/api/v1/importerofrecord/{id}"},{"label":"Update Importer of Record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/updateimporterofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/updateimporterofrecord","metadata":{"seo":{"title":"Update Importer of Record","description":"Update the Importer of Record entry with new values for iorCode,description, and countryCode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateImporterOfRecord","name":"Update Importer of Record","isWebhook":false,"pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Importer of Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the Importer of Record entry with new values for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Unique identifier of the Importer of Record entry.","required":true}],"pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordUpdate"}},"schemaId":"components/schemas/ImporterOfRecordUpdate","pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/importerofrecord/{id}","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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordUpdate"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/importerofrecord/{id}","href":"importer-of-record/updateimporterofrecord","openApiOperationId":"updateImporterOfRecord","summary":"Update Importer of Record"},"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/ImporterOfRecordUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImporterOfRecordUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Importer of Record successfully updated."},{"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~1importerofrecord~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"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":"/importer-of-record/updateimporterofrecord"}],"panels":[]}]},"httpPath":"/api/v1/importerofrecord/{id}"},{"label":"Detete Importer of Record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/deleteimporterofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/deleteimporterofrecord","metadata":{"seo":{"title":"Detete Importer of Record","description":"This operation deletes the Importer of Record entry identified by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteImporterofRecord","name":"Detete Importer of Record","isWebhook":false,"pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detete Importer of Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation deletes the Importer of Record entry identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"Unique identifier of the Importer of Record entry.","required":true}],"pointer":"/paths/~1api~1v1~1importerofrecord~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/importerofrecord/{id}","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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/importerofrecord/{id}","href":"importer-of-record/deleteimporterofrecord","openApiOperationId":"deleteImporterofRecord","summary":"Detete Importer of Record"},"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Import of Record Code has beed deleted successfully."},{"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~1importerofrecord~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"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":"/importer-of-record/deleteimporterofrecord"}],"panels":[]}]},"httpPath":"/api/v1/importerofrecord/{id}"}],"content":{"contentType":"group","meta":{"name":"Importer of Record"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Importer of Record","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/importerofrecord","summary":"Create Importer of Record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/importer-of-record/createimporterofrecord","deprecated":false},{"title":"/api/v1/importerofrecord","summary":"Get Importers of Record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/importer-of-record/getimportersofrecord","deprecated":false},{"title":"/api/v1/importerofrecord/{id}","summary":"Get Importer of Record by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/importer-of-record/getimporterofrecordbyid","deprecated":false},{"title":"/api/v1/importerofrecord/{id}","summary":"Update Importer of Record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/importer-of-record/updateimporterofrecord","deprecated":false},{"title":"/api/v1/importerofrecord/{id}","summary":"Detete Importer of Record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/importer-of-record/deleteimporterofrecord","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 Fields not found"}}}}}}},"components/schemas/ImporterOfRecordCreate":{"id":"components/schemas/ImporterOfRecordCreate","kind":"json-schema","title":"ImporterOfRecordCreate","data":{"type":"object","required":["iorCode","countryCode"],"description":"Request body for creating an Importer of Record.","properties":{"iorCode":{"type":"string","description":"Unique code for the Importer of Record entry.","example":"code28080001"},"description":{"type":"string","description":"Human-readable description of the Importer of Record.","example":"this is description for test codehashcode28080001"},"countryCode":{"type":"string","description":"Two-letter ISO country code where this Importer of Record is registered.","example":"US"}}}},"components/schemas/ImporterOfRecordUpdate":{"id":"components/schemas/ImporterOfRecordUpdate","kind":"json-schema","title":"ImporterOfRecordUpdate","data":{"type":"object","description":"Request body for updating or partially updating an Importer of Record.","properties":{"iorCode":{"type":"string","description":"Updated code for the Importer of Record.","example":"code28080001"},"description":{"type":"string","description":"Updated description.","example":"this is description for test codehashcode28080001-u1"},"countryCode":{"type":"string","description":"Updated ISO country code.","example":"IN"}}}},"components/schemas/ImporterOfRecordCreated":{"id":"components/schemas/ImporterOfRecordCreated","kind":"json-schema","title":"ImporterOfRecordCreated","data":{"type":"object","description":"Response returned after creating an Importer of Record.","properties":{"id":{"type":"string","description":"Unique system identifier of the created entry.","example":"68afedcf556ad316aa50ccc7"}}}},"components/schemas/ImporterOfRecord":{"id":"components/schemas/ImporterOfRecord","kind":"json-schema","title":"ImporterOfRecord","data":{"type":"object","description":"Complete Importer of Record object.","properties":{"id":{"type":"string","description":"Unique identifier of the Importer of Record.","example":"68afedcf556ad316aa50ccc7"},"iorCode":{"type":"string","description":"Code assigned to the Importer of Record.","example":"code28080001"},"description":{"type":"string","description":"Description of the Importer of Record Code.","example":"this is description for test codehashcode28080001"},"countryCode":{"type":"string","description":"Two-letter ISO country code where this Importer of Record is registered.","example":"US"},"archived":{"type":"boolean","description":"Whether the Importer of Record is archived.","example":false}}}},"components/schemas/ImporterOfRecordListItem":{"id":"components/schemas/ImporterOfRecordListItem","kind":"json-schema","title":"ImporterOfRecordListItem","data":{"allOf":[{"$ref":"#/components/schemas/ImporterOfRecord"}],"description":"Entry returned in lookup results."}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"insertTimestamp,DESC"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ImporterOfRecordListItem"}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"}},"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)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/importerofrecord.json?download"},{"url":"/_bundle/openapi/importerofrecord.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Importer of Record API","description":"Manage **Importer of Record (IOR)** entries that represent legal entities responsible\nfor ensuring compliance of imported goods with local customs regulations, including\nfiling declarations and paying duties/taxes.\nThese APIs allow you to:\n- Create an Importer of Record definition with a unique code and associated country.\n- Retrieve an Importer of Record by its unique identifier.\n- Lookup and filter Importers of Record by metadata.\n- Update or partially update Importer of Record details.\n- Delete Importers of Record no longer in use.\n"}},"baseSlug":"/openapi/importerofrecord","routesMapping":{}}