/

Docs
History
Schema
Generate

Filter operations

get/brand/markup_rulesGet Brand Markup Rules
patch/brand/markup_rulesPatch Brand Markup Rules
post/brand/markup_rules/{id}Create Duplicate Sm
delete/brand/markup_rules/{id}Delete Duplicate Sm
get/brand/configGet Brand Config
patch/brand/configPatch Brand Config
get/brand/cartonization-alertsGet Brand Cartonization Alerts
get/brand/cartonization-logsGet Brand Cartonization Logs
put/brand/mat-rule-boxesPut Brand Mat Rule Boxes
get/brand/cartonization-backupGet Brand Cartonization Backup
put/brand/cartonization-backupPut Brand Cartonization Backup
get/brand/ship-option-groupsGet Brand Ship Option Groups
put/brand/ship-option-groupsPut Brand Ship Option Groups
get/brand/product-dimensionsList Brand Product Dimensions
post/brand/product-dimensionsCreate Brand Product Dimension
post/brand/product-dimensions/importImport Brand Product Dimensions
post/brand/product-dimensions/sync-shopifySync Brand Shopify Dimensions
get/brand/product-dimensions/historyList Brand Product Dimension History
get/brand/shopify-product-variantsSearch Shopify Product Variants
delete/brand/product-dimensions/{shopify_variant_id}Delete Brand Product Dimension
patch/brand/product-dimensions/{shopify_variant_id}Update Brand Product Dimension
get/brand/free-shipping/excluded-statesGet Brand Free Shipping Excluded States
put/brand/free-shipping/excluded-statesReplace Brand Free Shipping Excluded States
post/brand/free-shipping/excluded-states/{state_code}Add Brand Free Shipping Excluded State
delete/brand/free-shipping/excluded-states/{state_code}Remove Brand Free Shipping Excluded State
get/brand/onboarding_statusGet Brand Onboarding Status
patch/brand/onboarding_status/onboarding_video_watchedMark Onboarding Video Watched
patch/brand/onboarding_status/fulfillment_settings_reviewedMark Fulfillment Settings Reviewed
patch/brand/onboarding_status/delivery_customization_setupMark Delivery Customization Setup
patch/brand/onboarding_status/onboarding_call_scheduledMark Onboarding Call Scheduled
get/brand/usage_billingGet Brand Usage Billing
post/brand/usage_billing/banner_dismissDismiss Brand Usage Billing Banner
get/brand/billing/stateBrand Billing Access
post/brand/billing/verifyVerify Brand Billing
get/brand/provider_profileGet Brand Provider Profile
get/brand/fulfillment_locationGet Brand Fulfillment Location
patch/brand/fulfillment_locationPatch Brand Fulfillment Location
post/brand/fulfillment_location/inferInfer Brand Fulfillment Location
get/brand/fulfillment_opening_hoursGet Brand Fulfillment Opening Hours
patch/brand/fulfillment_opening_hoursPatch Brand Fulfillment Opening Hours
patch/brand/fulfillment_location/confirmConfirm Brand Fulfillment Location
get/brand/cartonization-email-settingsGet Brand Cartonization Email Settings
patch/brand/cartonization-email-settingsPatch Brand Cartonization Email Settings
get/brand/default-resultsGet Brand Default Results
put/brand/default-results/{lane}Upsert Brand Default Result
get/brand/hs-code-country-restrictionsGet Brand Hs Code Country Restrictions
put/brand/hs-code-country-restrictionsReplace Brand Hs Code Country Restrictions
patch/brand/hs-code-country-restrictions/enabledSet Brand Hs Code Country Restrictions Enabled
get/brand/shipping-restriction-rulesGet Brand Shipping Restriction Rules
put/brand/shipping-restriction-rulesReplace Brand Shipping Restriction Rules
patch/brand/shipping-restriction-rules/enabledSet Brand Shipping Restriction Rules Enabled
post/brand/shipping-restriction-rules/previewPreview Brand Shipping Restriction Rules
patch/brand/reorderToggle Method Reorder
post/brand/delivery_customization/syncSync Delivery Customization Priorities
post/brand/delivery_customization/installInstall Delivery Customization Priorities
get/3pl/markup_rulesGet 3Pl Markup Rules
patch/3pl/markup_rulesPatch 3Pl Markup Rules
post/3pl/markup_rules/{id}Create Duplicate Sm
delete/3pl/markup_rules/{id}Delete Duplicate Sm
get/3pl/settings/zone-markups/methodsList Zone Markup Methods
get/3pl/settings/zone-markupsGet Zone Markup Table
put/3pl/settings/zone-markupsPut Zone Markup Table
get/3pl/configGet Provider
get/3pl/brandsGet 3Pl Owned Brands
get/3pl/brands/{brand_id}/ship-option-groupsGet 3Pl Brand Ship Option Groups
put/3pl/brands/{brand_id}/ship-option-groupsPut 3Pl Brand Ship Option Groups
patch/3pl/brand-configPatch 3Pl Owned Brands
get/3pl/settings/shipping-locationGet Primary Shipping Location
patch/3pl/settings/shipping-locationPatch Primary Shipping Location
get/3pl/settings/opening-hoursGet Opening Hours Settings
patch/3pl/settings/opening-hoursPatch Opening Hours Settings
get/3pl/settings/usersList Provider Users
post/3pl/settings/usersCreate Provider User
delete/3pl/settings/users/{provider_user_id}Disable Provider User
patch/3pl/settings/users/{provider_user_id}Update Provider User
get/3pl/settings/referralsGet Provider Referrals
post/3pl/settings/referralsCreate Provider Referral
delete/3pl/settings/referrals/{referral_id}Delete Provider Referral
get/3pl/settings/default-methodsGet Provider Method Defaults
patch/3pl/settings/default-methodsPatch Provider Method Defaults
post/3pl/settings/default-methods/seed-from-brandSeed Provider Method Defaults From Brand
get/3pl/settings/profileGet Provider Brand Profile
patch/3pl/settings/profilePatch Provider Brand Profile
get/3pl/settings/rate-accountGet Provider Rate Account
patch/3pl/settings/rate-accountPatch Provider Rate Account
get/3pl/settings/easypost-connectionsGet Easypost Connections
patch/3pl/settings/easypost-connectionsSave Easypost Connection
patch/3pl/settings/ship-method-accountSave Ship Method Account
post/3pl/settings/rate-account/validateValidate Provider Rate Account
get/3pl/settings/templatesGet Provider Template Settings
patch/3pl/settings/templatesPatch Provider Template Settings
get/onboarding/3pl/configGet Provider Onboarding Config
post/onboarding/3pl/auth-resetReset Provider Onboarding Auth Session
post/onboarding/3pl/sessionCreate Provider Onboarding Session
get/onboarding/3pl/session/{session_id}Get Provider Onboarding Session
patch/onboarding/3pl/session/{session_id}Update Provider Onboarding Session
post/onboarding/3pl/session/{session_id}/finalizeFinalize Provider Onboarding Session
post/onboarding/3pl/rate-integrations/validateValidate Provider Onboarding Rate Integration
post/onboarding/3pl/session/{session_id}/cognito-signupStart Provider Onboarding Cognito Signup
post/onboarding/3pl/session/{session_id}/cognito-confirmConfirm Provider Onboarding Cognito Signup
post/onboarding/3pl/session/{session_id}/cognito-sessionAttach Cognito Provider Onboarding Session

Changes to Brand Billing Access

get/brand/billing/state

Oct 14, 202607ed402ae9c9 Revision changes
- info
  endpoint added