Skip to main content

Update 3PL Order Label Settings

PUT 

/api/walmart/:integrationInstance/sww-label-settings

Update the settings for buying Ship With Walmart labels for seller-fulfilled Walmart orders that a 3PL warehouse ships. Only the fields sent are changed; other Walmart integration settings are kept. Turning the setting on without choosing a shipping method creates (or reuses) a "Walmart Label Provided" shipping method and uses it. Returns the saved settings.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Requires the integrations.update permission.

Request body:

  • purchase_for_3pl_orders (boolean, required): turn automatic label buying on or off.
  • service_preference (string, optional): cheapest or match_requested. Unchanged when omitted.
  • label_provided_shipping_method_id (integer|null, optional): an existing shipping method ID to switch label-provided fulfillment orders to. Send null to use the default "Walmart Label Provided" method. Unchanged when omitted.
  • fallback_box (object|null, optional): default box for multi-unit orders with no known box size. Send null to clear it. When sent, all four fields are required:
    • fallback_box.length (number, > 0)
    • fallback_box.width (number, > 0)
    • fallback_box.height (number, > 0)
    • fallback_box.unit (string): in or cm

The response has the same shape as Get 3PL Order Label Settings.

Path parameters:

  • integrationInstance (required): Walmart integration instance ID.

Request​

Responses​

OK

Response Headers
    Content-Type