Skip to content

Filter sales orders (retired v1)

Open .md

POST/v1/api/store/{team_slug}/sales_order/filter

v1Legacy · deprecatedOperation ID v1_public_v1_sales_order_filter

Retired: this v1 operation no longer works. Every call fails with HTTP 500 and the body {"message": "Server Error"}. Use List sales orders (v2.public.sales_order.filter) to list sales orders.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Request body

This operation takes no request body.

Response

200Never sent: this route always fails with HTTP 500.

No response body.

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  • 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

    When
    Always: {"message": "Server Error"}.
    Fix
    Use List sales orders.