- Using OGOship OpenAPI
- ApiV1
- Metadata
- Orders
- Products
- Returns
- Stock
- StockUpdate
- WebHooks
- Tracking Service
- Order Service
- Claims
- File a new claim based on orderId
- Get claims by orderId
- Get claim
- Update claim
- Create or update claim
- Get claims search definitions
- Get filtered claims
- Cancel claim.
- Refund claim to ecom.
- Get new claims dashboard data for a channel
- Set owner for a claim
- Remove owner from a claim
- Run action on claims
- Add a tag to a customer claim
- Remove a tag from a customer claim
- Emission
- Fabrikator
- Label
- Location
- Order
- Set order tracking status and tracking time
- Create exchange order
- Send exchange order (set to NEW status in myOGO1)
- Cancel order in myOGO1
- Stop (move to RESERVED status) order in myOGO1
- Search orders. Channel number specifies the location to search from.
- Get order by string orderId
- Create external order
- Update external order
- Get external order by orderId
- Get external orders by channelId
- ReturnDeliveryTypes
- Returns
- Change refund status of both return orders
- Gets list of returns
- Get filter definitions for front end search
- Search for orders with defined filters
- Gets return dashboard data
- Get return by id
- Gets return dashboard data
- Get myOgo2 return by returnId
- Update a myOGO2 return
- Get myOgo2 returns by orderId (Full info for admins or merchants)
- Get myOgo2 returns by orderId (customer version)
- Request a new return. Checks merchant settings and creates a return to myOGO1 if the status of the return is WAITING.
- Get channels myOgo2 returns
- Run actions for returns
- Get filter definitions for front end search
- Approve requested return order.
- Close requested return order.
- Change return order back to requested status.
- Cancel return order.
- Create return to ecom.
- Complete return at ecom.
- Create shipment to tracking service from return order.
- Merge returns.
- Update exchange order to be sent in ecom and/or myOGO.
- Create or update draft return order
- Initialize return from claim
- Initialize return from order
- Finish draft return
- Create exchange order (admin only)
- Send notification to customer about return order
- Get open returns dashboard data for a channel
- Set owner for a return
- Remove owner from a return
- Add a tag to a return order
- Remove a tag from a return order
- Shipment
- Claims
- Notification Service
- ChannelEvents
- Chat
- Get chat conversation by id
- Create or update chat conversation (Admin or system only)
- Update an existing chat conversation
- Delete chat conversation (Admin or system only)
- Get chat conversation by id with messages
- Get chat messages for a conversation
- Get all chat conversations for a channel
- Create a new chat conversation
- Add a single message to an existing chat conversation
- Set feedback on a chat message
- /chat/{channelId}/dashboard
- KlaviyoApi
- Configure Klaviyo integration for a channel with API keys
- Get Klaviyo account details for a channel
- Get lists from Klaviyo
- Get segments from Klaviyo
- Get email templates from Klaviyo
- Create or update a profile in Klaviyo
- Add a profile to a list
- Send a transactional email through Klaviyo
- Track a custom event in Klaviyo
- Update account metrics from Klaviyo
- Remove Klaviyo integration for a channel
- Messaging
- Notifications
- NotificationSettings
- NotificationTemplate
- Get frame for editor
- Update existing frame
- Remove existing frame
- Get frame for editor
- Update existing template
- Get all templates by channel id
- Get all frames by channel id
- Add new template
- Add new frame
- Preview frame
- Preview template
- Preview template to email/SMS
- Get sample model
- Copy all frames from another channel Overwrite: true will overwrite existing frames, false will only copy missing frames
- Copy all templates from another channel Overwrite: true will overwrite existing templates, false will only copy missing templates
- Delete all old frames and templates and copy new ones from source channel to target channel Overwrite input has no effect
- /notificationTemplates/ogoTemplates
- /notificationTemplates/ogoUsageKeys
- SlackApi
- Transactional
- Creates new messagePOST
- Gets messageGET
- Updates existing message if existPUT
- Getting message by idGET
- Marking message as deletedDELETE
- Get all active messages using merchantId identifier. Marks all as read.GET
- Add transaction to message using merchantId identifier.
(Draft = 0, Sent = 1, Read = 2, Skipped = 3, Agreed = 4, Rejected = 5)PATCH
- Get's all recipients of message
(Draft = 0, Sent = 1, Read = 2, Skipped = 3, Agreed = 4, Rejected = 5)GET
- Adds recipient to message
Returns list of recipientsPUT
- Updates all recipients for messagePATCH
- Simplified add recipient
Returns list of recipients for current merchantPUT
- Simplified add recipient
Returns list of recipients for current merchantDELETE
- Create transactionPOST
- Create transactionPOST
- Generates message token
(DEV_ONLY)
Crashes APIGET
- Creates new message
- WebHook
- ZendeskApi
- Generates a Zendesk OAuth authorization link for the user to authorize the application.
- Handles the OAuth callback from Zendesk after user authorization
- Get tickets from Zendesk for a channel
- Get Zendesk account details for a channel
- Get available groups from Zendesk
- Create a new ticket in Zendesk
- Add a comment to an existing ticket
- Update a ticket's status
- Removes the Zendesk integration for the specified channel
- Schemas
- Schemas
- AddCommentRequest
- AddToListRequest
- ChannelEventOption
- ChannelEventOptionTemplate
- ChannelEventSubscriptionTemplate
- ChannelEventSubscriptionsDto
- ChannelNotificationsSettingsDto
- ChannelNotificationsSettingsUpdateDto
- ProblemDetails
- ChatConversationDto
- ChatConversationUpdateDto
- ChatMessageDto
- ChatParticipantDto
- ConfigureKlaviyoRequest
- ConversationDashboardDto
- ConversationMetadataDto
- ConversationMetadataUpdateDto
- CopySettings
- CreateProfileRequest
- CreateTicketRequest
- CreateTransactionalMessageModel
- CustomWebhookMessage
- EChannelEventOptionType
- EContentType
- EMessageApproval
- EMessageReceiver
- EMessageRecipientStatus
- EMessageRecipientType
- EMessageSource
- EMessageType
- EventDeliveryTypeDto
- EventSubscriptionDto
- Feedback
- FileAttachmentDto
- FrameDetails
- KlaviyoAccountPublicDetails
- LocaleString
- MessageContentDto
- MessageContext
- MessageDto
- MessageFeedbackDto
- NotificationChannels
- NotificationFrameDto
- NotificationProviderSettingsDto
- NotificationTemplateDto
- ProviderResponse
- ProvidersListResponse
- RecipientTransactionsDto
- SendAttachmentDto
- SendDto
- SendEmailRequest
- SendRawDto
- SendTestDto
- SlackTeam
- SlackTeamPublicDetails
- StringStringKeyValuePair
- TemplateLocalizedString
- TrackEventRequest
- TransactionDto
- TransactionalMessageContentDto
- TransactionalMessageDto
- UiDataField
- UiDataFieldOption
- UpdateTicketStatusRequest
- WebHookRedisListModel
- WebHookStatus
- ZendeskAccountPublicDetails
- Schemas
Updates all recipients for message
Production
https://api.ogoship.com/api
Production
https://api.ogoship.com/api
PATCH
/transactional/{messageId}/recipients
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
Body Params application/json
Example
[
{
"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"messageUID": "c5a3cf10-5f22-4ba6-8e90-7a522ec0611f",
"recipient": "string",
"status": "Draft",
"transactions": [
{
"time": "2019-08-24T14:15:22.123Z",
"status": "Draft",
"userName": "string",
"service": "string",
"source": "string"
}
]
}
]Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.ogoship.com/api/transactional//recipients' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"messageUID": "c5a3cf10-5f22-4ba6-8e90-7a522ec0611f",
"recipient": "string",
"status": "Draft",
"transactions": [
{
"time": "2019-08-24T14:15:22.123Z",
"status": "Draft",
"userName": "string",
"service": "string",
"source": "string"
}
]
}
]'Responses
🟢200OK
text/plain
Body
Example
[
{
"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"messageUID": "c5a3cf10-5f22-4ba6-8e90-7a522ec0611f",
"recipient": "string",
"status": "Draft",
"transactions": [
{
"time": "2019-08-24T14:15:22.123Z",
"status": "Draft",
"userName": "string",
"service": "string",
"source": "string"
}
]
}
]🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-08-27 08:28:05