When creating orders via the API, you must populate specific shipping fields to correctly route shipments through MasonHub. This section covers the required fields and standard mappings.

Required Fields

When creating orders, you must specify both the shipping provider and service level:

shipping_service_provider

The shipper to use for this package (e.g., “masonhub”, “willCall”)

shipping_service_level

The type of service level required (e.g., “ground”, “2day”, “overnight”)

Standard Ship Method Mappings

MasonHub Carrier Services

Service ProviderService LevelDescription
masonhubgroundStandard ground shipping
masonhubgroundPlusEnhanced ground service
masonhub3day3-day delivery service
masonhub2day2-day delivery service
masonhubstandardOvernightNext day delivery (standard)
masonhubpriorityOvernightNext day delivery (priority)

Special Services

Service ProviderService LevelDescription
willCallwillCallCustomer pickup at warehouse

During onboarding, you’ll work with your MasonHub resource to ensure ship methods are mapped according to your business requirements.

Example Order Creation

Here’s how to properly set shipping information when creating an order:

{
  "order": {
    "external_id": "ORDER-12345",
    "shipping_address": {
      "name": "John Doe",
      "street": "123 Main St",
      "city": "Springfield",
      "state": "IL",
      "zip": "62701",
      "country": "US"
    },
    "shipping_service_provider": "masonhub",
    "shipping_service_level": "2day",
    "line_items": [
      {
        "sku": "PRODUCT-001",
        "quantity": 2,
        "price": 25.00
      }
    ]
  }
}

📘 Reference: Create Order API

Error Handling

Common Mapping Errors

If the mapping is incorrect or hasn’t been set up on the MasonHub side, you’ll receive an API error message.

Example Error Response:

{
  "error": {
    "code": "INVALID_SHIP_METHOD",
    "message": "Ship method mapping not found",
    "details": {
      "shipping_service_provider": "invalid_provider",
      "shipping_service_level": "ground"
    }
  }
}

Troubleshooting Steps

1

Verify Mapping Configuration

Confirm your ship methods are configured in MasonHub

2

Check Field Values

Ensure you’re using exact values from the approved mappings

3

Contact Support

Reach out to your onboarding resource or support team

Custom Ship Method Setup

During Onboarding

Work with your MasonHub onboarding resource to:

  • Map ERP Ship Methods: Connect your internal shipping codes to MasonHub values
  • Configure Service Levels: Set up service level agreements and delivery expectations
  • Test Mappings: Validate mappings work correctly in sandbox environment

Adding New Ship Methods

Regional Considerations

Domestic vs. International

Different ship methods may be required based on destination:

  • Standard ground services
  • Express delivery options
  • Regional carrier preferences

API Reference

Create Order API

Complete API documentation for order creation with shipping parameters

Support

For additional ship mapping questions or configuration issues:

Onboarding Support

Contact your assigned onboarding resource

Technical Support

Next Steps

Once your ship method mappings are configured, proceed to learn about getting data back into the ERP / Source System.