Skip to content

feat: add custom headers support, enhance patch_item#6

Merged
mayurrawte merged 3 commits intomainfrom
feature/custom-headers-webhook-sync
Feb 6, 2026
Merged

feat: add custom headers support, enhance patch_item#6
mayurrawte merged 3 commits intomainfrom
feature/custom-headers-webhook-sync

Conversation

@mayurrawte
Copy link
Copy Markdown
Member

@mayurrawte mayurrawte commented Feb 6, 2026

Summary

  • Add custom_headers parameter for server-to-server auth override
  • Make x_api_key optional (can use custom_headers instead)
  • Add per-request header override support
  • Enhance patch_item with better documentation as the recommended way to update fields
  • Add create_reference_linked_field method
  • Bump version to 2.2.0

Usage

from ShipthisAPI import ShipthisAPI

# Standard usage
client = ShipthisAPI(
    organisation="your_org_id",
    x_api_key="your_api_key"
)

# Patch document fields (recommended)
client.patch_item(
    "fcl_load",
    "68a4f906743189ad061429a7",
    update_fields={"container_no": "CONT123", "seal_no": "SEAL456"}
)

Test plan

  • Verify custom_headers work correctly
  • Test patch_item updates fields as expected

- Add custom_headers parameter to override default headers
- Make x_api_key optional (can use custom_headers for auth)
- Add per-request header override support
- Add webhook_sync method for synchronous updates
- Add webhook_update method for async updates with actions
- Add create_reference_linked_field method
- Bump version to 2.2.0
@mayurrawte mayurrawte changed the title feat: add custom headers support and webhook methods feat: add custom headers support, enhance patch_item Feb 6, 2026
@mayurrawte mayurrawte merged commit 2f84afe into main Feb 6, 2026
3 of 4 checks passed
@mayurrawte mayurrawte deleted the feature/custom-headers-webhook-sync branch February 6, 2026 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants