List ShipMyOrders Invoice Nominal Code Mapping Rules
GET/api/shipmyorders/invoices/mapping-rules
Lists the nominal-code mapping rules used to code ShipMyOrders invoice lines, in evaluation order.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Rules are evaluated in sort_order order when an invoice is processed; the first rule whose conditions all match a line sets that line's nominal code. Each condition has column, operator and value:
descriptionorquantitywith=,!=,>,>=,<,<,contains,not contains(case-insensitive),in,not in(valueis a comma-separated list)salesorderwithexists/not exists— whether the line matched a SKU.io fulfillment (valueis ignored, send null) A condition on any other column never matches.
Per rule: id, nominal_code_id, sort_order, conditions, created_at, updated_at. No parameters.
Authentication: Bearer token (Personal Access Token).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.