SpeedX RPS (Rapid Printing Service) allows developers to integrate shipping label functionalities into their systems with ease. The API supports various features including label printing, label updating, label cancellation, manifest generation, and tracking. Follow the guidelines below to get started. For further assistance, reach out to us at tech.support@speedx.io.
\nBefore shipping, all parcels must be properly manifested. Failure to do so may result in un-manifested penalties. If you encounter any issues with the manifest, please reach out to SpeedX support immediately at tech.support@speedx.io
\nCreate Label (Required)
\nSubmit Manifest (Required)
\nAll API calls require authentication via an API key. The key is included in the 'api-key' parameter within the HTTP request header. This key is issued to each user account upon creation by the Account Manager.
\nProtocol: RESTful API, utilizing JSON requests and responses.
\nHeader Requirements:
\nContent-Type: application/json
\napi-key (authentication parameter)
\nStatus Codes:
\nSuccessful Requests: HTTP status code 200, with or without a JSON response body depending on the request.
\nError Responses: HTTP status code 200 with a JSON payload including error details (code and message).
\nNote:
\nSandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/create-label
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/create-label
\nOverview
\nFields marked as Required are essential for certain services. Ensure the correct fields are included by checking the \"Required\" column in each section.
\nMany field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.
\nProvide all necessary information for recipient address.
\nAccepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
\nAll other characters are replaced with spaces.
\nProvide details for return address. Some services may not require a return address; check with your Account Manager.
\nAccepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
\nAll other characters are replaced with spaces.
\nProvide all necessary information for ship from address.
\nAccepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
\nAll other characters are replaced with spaces.
\nDisplay custom information on the bottom area of the label, such as remarks.
\nEnter commodity information for shipped goods.
\nProvide the feature information
\nProvide the labelSettingForm information
\nSandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/get-label-base64/v2
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/get-label-base64/v2
\nOverview
\nFields marked as Required are essential for certain services. Ensure the correct fields are included by checking the \"Required\" column in each section.
\nMany field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.
\nSandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/get-label-base64/pdf/:trackingNumber
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/get-label-base64/pdf/:trackingNumber
\n","urlObject":{"path":["rps-api","label","get-label-base64","pdf",":trackingNumber"],"host":["https://rps-sandbox.speedx.io"],"query":[],"variable":[{"type":"any","value":"SPX2GE042101786698","key":"trackingNumber"}]}},"response":[{"id":"7ec6f372-7d2f-403e-a514-054334599ed4","name":"Get Label by Tracking Number","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"Sandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/get-label-by-customer-ref-id/:customerRefId
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/get-label-by-customer-ref-id/:customerRefId
\n","urlObject":{"path":["rps-api","label","get-label-by-customer-ref-id",":customerRefId"],"host":["https://rps-sandbox.speedx.io"],"query":[],"variable":[{"type":"any","value":"d5yip9hbhee92","key":"customerRefId"}]}},"response":[{"id":"bb9af20c-6b3c-4655-98b4-f79aab379eca","name":"Get Label by Customer Ref Id","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"Sandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/update-label
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/update-label
\nProvide commodity information.
\n","urlObject":{"path":["rps-api","label","update-label"],"host":["https://rps-sandbox.speedx.io"],"query":[],"variable":[]}},"response":[{"id":"155706a1-deb5-42ee-9654-888d1b7c8481","name":"Update Label Sample","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"If the label is successfully voided, the label's amount will be refunded to the account.
\nSandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/void-labels
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/void-labels
\n","urlObject":{"path":["rps-api","label","void-labels"],"host":["https://rps-sandbox.speedx.io"],"query":[],"variable":[]}},"response":[{"id":"f83e259d-ea12-4b82-8995-f54f421433df","name":"Void labels","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"⚠ This API is under development and not available in production.
\nSandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/label/handover
\nProduction:
\nhttps://rps.speedx.io/rps-api/label/handover
\nSubmit parcel relationship and handover time information.
\nIf you encounter any issues with the handover, please contact SpeedX support as soon as possible at tech.support@speedx.io.
\nLabel Section provide a set of APIs to allow users to create, update, and void labels.
\n","_postman_id":"8316f9cc-a0e7-4fab-8044-617ecdf23549"},{"name":"Manifest","item":[{"name":"Submit Manifest","id":"dc3a92d2-be61-4249-812a-fca341d49679","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"Sandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/manifest/submit
\nProduction:
\nhttps://rps.speedx.io/rps-api/manifest/submit
\nAll parcels must be included in the manifest before being shipped. Any parcels that are not manifested may incur penalties for being un-manifested.
\nIf you encounter any issues with the manifest, please contact SpeedX support as soon as possible at tech.support@speedx.io.
\nSandbox:
\nhttps://trk-sandbox.speedx.io/tracking-api/event/external/v2?version=2
\nProduction:
\nhttps://trk.speedx.io/tracking-api/event/external/v2?version=2
\nRetrieve tracking events for up to 30 tracking numbers in a single API call.
\nThe event codes and their descriptions will be provided during the onboarding process.
\nIndicate the version of event code
\n","type":"text/plain"},"key":"version","value":"2"}],"variable":[]}},"response":[{"id":"c170733f-8f73-4596-97b4-4464cb5ad207","name":"Get Tracking","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"Only incremental tracking events will be emitted.
\nEach event will be pushed at most 3 times until HTTP code 200 response is returned.
\nIf authorization is required, please provide your authorization token to Tech Support.
\nSandbox:
\nhttps://trk-sandbox.speedx.io/tracking-api/pod/:trackingNumber
\nProduction:
\nhttps://trk.speedx.io/tracking-api/pod/:trackingNumber
\nTo retrieve the proof of delivery photos for the given tracking number, follow the designated retrieval process.
\n","urlObject":{"path":["tracking-api","pod",":trackingNumber"],"host":["https://trk-sandbox.speedx.io"],"query":[],"variable":[{"type":"any","value":"SPX1GE056709911650","key":"trackingNumber"}]}},"response":[{"id":"40187952-71be-47df-a9d2-75c53f57a4ec","name":"Get Pod","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"Sandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/rate/get-rate
\nProduction:
\nhttps://rps.speedx.io/rps-api/rate/get-rate
\nFields marked as Required are essential for certain services. Ensure the correct fields are included by checking the \"Required\" column in each section.
\nMany field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.
\nProvide all necessary information for recipient address.
\nAccepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
\nAll other characters are replaced with spaces.
\nSandbox:
\nhttps://rps-sandbox.speedx.io/rps-api/sort-code/get
\nProduction:
\nhttps://rps.speedx.io/rps-api/sort-code/get
\nFields marked as Required are essential for certain services. Ensure the correct fields are included by checking the \"Required\" column in each section.
\nMany field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.
\nFields marked as Required are essential for certain services. Ensure the correct fields are included by checking the \"Required\" column in each section.
\nMany field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.
\nProvide all necessary information for pickup address.
\nAccepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
\nAll other characters are replaced with spaces.
\n![https://spxblob.blob.core.windows.net/prod-blob/pod/2024/4/14/SPX1GE056709911650-a709077256d09600cc5e1e3c6f1be120.jpg\"](\"https://spxblob.blob.core.windows.net/prod-blob/pod/2024/4/14/SPX1GE056709911650-a709077256d09600cc5e1e3c6f1be120.jpg\"){kind=link}
![https://spxblob.blob.core.windows.net/1.jpg\"]](\"https://spxblob.blob.core.windows.net/1.jpg\"){kind=link}
![https://spxblob.blob.core.windows.net/2.jpg\"]](\"https://spxblob.blob.core.windows.net/2.jpg\"){kind=link}