{"items":[{"type":"link","label":"Custom Fields APIs","link":"/openapi/customfields","routeSlug":"/openapi/customfields","content":{"contentType":"overview","meta":{"name":"Custom Fields APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"customfields.json","url":"/_bundle/openapi/customfields.json?download"},{"kind":"download","label":"customfields.yaml","url":"/_bundle/openapi/customfields.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/platformapis","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/platformapis","description":"Production Server (uses live data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Custom Fields APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Custom fields represent additional attributes that can be associated with package-related data. These fields are created and managed through the platform UI and are exposed via APIs for integration and data retrieval purposes."}],"sectionId":"/openapi/customfields"}],"sectionId":"/openapi/customfields"}]}]}},{"type":"group","label":"Custom Fields","link":"/openapi/customfields/custom-fields","routeSlug":"/openapi/customfields/custom-fields","items":[{"label":"Get Custom Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfields/custom-fields/getcustomfield","routeSlug":"/openapi/customfields/custom-fields/getcustomfield","metadata":{"seo":{"title":"Get Custom Fields","description":"This operation retrieves the list of custom fields defined on the platform. Custom fields are additional package fields that can be displayed on PitneyTrack workflow pages.Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomField","name":"Get Custom Fields","isWebhook":false,"pointer":"/paths/~1api~1v1~1customfields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Custom Fields","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 retrieves the list of custom fields defined on the platform. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are additional package fields that can be displayed on PitneyTrack workflow pages.Custom fields can be created from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"My Settings > Custom Fields > Add Custom Field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the platform settings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_252","description":"The page number of the results to retrieve. Pagination starts from 0.","example":"0"},{"name":"limit","in":"query","schemaId":"schema_252","description":"The number of custom fields to retrieve per page.","example":"25"},{"name":"searchBy","in":"query","schemaId":"schema_253","description":"Search criteria for custom fields.","example":"status:ACTIVE, name:customFieldName"},{"name":"query","in":"query","schemaId":"schema_253","description":"Search by name for custom fields.","example":"name:customFieldName"}],"pointer":"/paths/~1api~1v1~1customfields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customfields","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/platformapis","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/platformapis","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"skip","in":"query","required":false,"example":"0","schemaId":"schema_252"},{"name":"limit","in":"query","required":false,"example":"25","schemaId":"schema_252"},{"name":"searchBy","in":"query","example":"status:ACTIVE, name:customFieldName","schemaId":"schema_253"},{"name":"query","in":"query","example":"name:customFieldName","schemaId":"schema_253"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customfields","href":"custom-fields/getcustomfield","openApiOperationId":"getCustomField","summary":"Get Custom Fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/platformapis","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/platformapis","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":"Custom fields fetched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldsResponse"}},"schemaId":"components/schemas/CustomFieldsResponse"},{"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~1customfields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldsResponse"}}},{"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":"/custom-fields/getcustomfield"}],"panels":[]}]},"httpPath":"/api/v1/customfields"},{"label":"Get Custom Field By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfields/custom-fields/getcustomfieldbyid","routeSlug":"/openapi/customfields/custom-fields/getcustomfieldbyid","metadata":{"seo":{"title":"Get Custom Field By ID","description":"Retrieves the details of a custom field using its unique custom field ID.Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomFieldById","name":"Get Custom Field By ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1customfields~1{customFieldId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Custom Field 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 the details of a custom field using its unique custom field ID."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields can be created from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"My Settings > Custom Fields > Add Custom Field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the platform settings"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customFieldId","in":"path","schemaId":"schema_253","description":"The unique identifier of the custom field to retrieve.","required":true,"example":"mMa0VjWvqbk8"}],"pointer":"/paths/~1api~1v1~1customfields~1{customFieldId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customfields/{customFieldId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/platformapis","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/platformapis","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"customFieldId","in":"path","required":true,"example":"mMa0VjWvqbk8","schemaId":"schema_253"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customfields/{customFieldId}","href":"custom-fields/getcustomfieldbyid","openApiOperationId":"getCustomFieldById","summary":"Get Custom Field By ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/platformapis","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/platformapis","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":"Requested Custom Field has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}},"schemaId":"schema_254"},{"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~1customfields~1{customFieldId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_254","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}}},{"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":"/custom-fields/getcustomfieldbyid"}],"panels":[]}]},"httpPath":"/api/v1/customfields/{customFieldId}"}],"content":{"contentType":"group","meta":{"name":"Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":"APIs for retrieving custom field definitions configured in the platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customfields","summary":"Get Custom Fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/getcustomfield","deprecated":false},{"title":"/api/v1/customfields/{customFieldId}","summary":"Get Custom Field By ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/getcustomfieldbyid","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/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of items available across all pages.","example":30},"startCount":{"type":"integer","description":"The starting position of the first item on the current page.","example":1},"limit":{"type":"integer","description":"The maximum number of items that can be displayed on a single page.","example":20}}}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","properties":{"customFieldId":{"type":"string","description":" A unique identifier assigned to the custom field.","example":"mMa0VjWvqbk8"},"name":{"type":"string","description":"The name of the custom field used for identification.","example":"Shelf#"},"customFieldType":{"type":"string","description":"Specifies the type of custom field.","example":"CHECKBOX","enum":["TEXT","RADIO","CHECKBOX"]},"defaultValue":{"type":"string","description":"The default value assigned to the custom field if no input is provided.","example":"top"},"status":{"type":"string","description":"Current status of Custom field.","example":"ACTIVE","enum":["ACTIVE","INACTIVE"]},"archived":{"type":"boolean","description":"If the custom field has been deleted or archived.","example":false},"values":{"description":" The value(s) assigned to the custom field. This parameter can hold either a single value or multiple values .","oneOf":[{"type":"string","description":"Single value for the custom field.","example":"Male"},{"type":"array","description":"List of values for the custom field.","items":{"type":"string"},"example":["Male","Female"]}]},"assignPageForm":{"type":"array","description":"A list of pages where the custom field is applied or assigned.","items":{"type":"string","example":"Receive, Edit, Deliver, Pouch"}}}}},"components/schemas/CustomFieldsResponse":{"id":"components/schemas/CustomFieldsResponse","kind":"json-schema","title":"CustomFieldsResponse","data":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}}}}},"schema_252":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"string"},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CustomField"}]},"id":"schema_254"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/platformapis","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/platformapis","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/customfields.json?download"},{"url":"/_bundle/openapi/customfields.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Custom Fields APIs","description":"Custom fields represent additional attributes that can be associated with package-related data. These fields are created and managed through the platform UI and are exposed via APIs for integration and data retrieval purposes."}},"baseSlug":"/openapi/customfields","routesMapping":{}}