Parcel Shield Orders API

Parcel Shield Order API Documentation

Overview and Purpose of the API

The Parcel Shield API Service is designed to facilitate seamless integration between Parcel Shield and MxTMS to create Orders. It provides endpoints to create orders and retrieve rates for orders.

The API is secured using OAuth 2.0, ensuring secure and authorized access to its endpoints. It is built to handle requests and responses in JSON format, making it easy to integrate with modern applications.

Authentication Requirements and Security Details

The Parcel Shield API Service uses OAuth 2.0 for authentication and authorization. Below are the details of the security implementation:

• Authorization Header: All requests to the API must include an Authorization header with a valid Bearer token.
• Token Endpoints:
  • Authorization URI: https://login.microsoftonline.com/d0bc7ed9-9964-48b5-a845-c5f4a2073269/oauth2/v2.0/token
• Grant Type: client_credentials
• Client ID: client_id
• Client Secret: client_secret
• Error Responses:
  • 401 Unauthorized: Indicates a bad or expired token.
  • 403 Forbidden: Indicates a bad OAuth request.

Consumer App onboarding

Step 1: In the Anypoint Exchange, the partner will submit a new app request.
Step 2: The partner will provide the support desk with the client ID and GUID via email.
Step 3: On behalf of the Partner, the Service Desk will open a ServiceNow ticket and assign it to the Azure Administrator.
Step 4: The Azure administrator will give the necessary scopes to the registered application and forward the request to the MuleSoft administrator.
Step 5: MuleSoft Admin will authorize the Partner's access request (new app request) and add the scope details to the API policy.
Step 6: The partner will receive an email with the request status.