{"openapi":"3.0.0","info":{"contact":{"email":"support@getcarro.com","name":"Support","url":"https://support.moderndropship.com"},"description":"Modern Dropship is the first B2B trade enablement network. This API allows developers to build on our seller and buyer capabilities. This API is unstable, meaning the endpoints could be added, updated or removed without notice. We intend to make backwards incompatible changes in the future, and will make best efforts to notify you in the event of your usage of impacted endpoints. If you plan to build on this API, please contact us for recommendations via support@getcarro.com.","termsOfService":"https://support.moderndropship.com/terms-of-service","title":"Shared API","version":"v2022-03-03"},"paths":{"/action-templates":{"get":{"description":"An endpoint for listing all the partner generated action templates","operationId":"list-action-templates","parameters":[{"description":"The page number of results to return","in":"query","name":"page","schema":{"type":"integer"}},{"description":"The maximum number of results to return per page","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The kind of action template to return","in":"query","name":"kind","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/models.ConsumableActionTemplate"},"type":"array"}},"type":"object"}]}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List action templates","tags":["Actions"]},"post":{"description":"An endpoint for creating a new partner generated action template","operationId":"create-action-template","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumableactions.CreateActionTemplateBody"}}},"description":"The body of the request for creating a new action template","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create action template","tags":["Actions"]}},"/action-templates/{id}":{"delete":{"description":"An endpoint for deleting a partner generated action template","operationId":"delete-action-template","parameters":[{"description":"The id of the action template to delete","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete action template","tags":["Actions"]},"patch":{"description":"An endpoint for updating an existing partner generated action template","operationId":"update-action-template","parameters":[{"description":"The id of the action template to update","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumableactions.UpdateActionTemplateBody"}}},"description":"The body of the request for updating an action template","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update action template","tags":["Actions"]}},"/actions":{"get":{"description":"An endpoint for listing all partner generated actions","operationId":"list-actions","parameters":[{"description":"The maximum number of actions to return","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"The number of actions to skip","in":"query","name":"offset","schema":{"type":"integer"}},{"description":"The field to sort the actions by","in":"query","name":"sort","schema":{"type":"string"}},{"description":"The direction to sort the actions","in":"query","name":"direction","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List actions","tags":["Actions"]},"post":{"description":"An endpoint for creating a new partner generated action","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumableactions.CreateConsumableActionBody"}}},"description":"The body of the request for creating a new action","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/consumableactions.CreateActionResponse"}},"type":"object"}]}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create action","tags":["Actions"]}},"/actions/{id}":{"delete":{"description":"An endpoint for deleting a partner generated action","operationId":"delete","parameters":[{"description":"The id of the action","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete action","tags":["Actions"]},"patch":{"description":"An endpoint for updating a partner generated action","operationId":"update","parameters":[{"description":"The id of the action","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumableactions.UpdateConsumableActionBody"}}},"description":"The body of the request for updating an action","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update action","tags":["Actions"]}},"/actions/{id}/status":{"patch":{"description":"An endpoint for updating the status of a partner generated action","operationId":"update-status","parameters":[{"description":"The id of the action","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumableactions.UpdateStatusBody"}}},"description":"The body of the request for updating the status of an action","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update action status","tags":["Actions"]}},"/actions/{id}/sync":{"patch":{"description":"An endpoint for syncing a single partner generated action","operationId":"sync-action","parameters":[{"description":"The id of the action","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Sync action","tags":["Actions"]}},"/actions/sync":{"post":{"description":"An endpoint for syncing the partner generated actions","operationId":"sync-actions","responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.APIWrapper"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Sync actions","tags":["Actions"]}},"/auth/me":{"get":{"description":"An endpoint for fetching data related to the current user and company.","operationId":"getMe","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.AuthMeResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"summary":"Get current user and company","tags":["User"]}},"/auth/me/getting-started":{"get":{"description":"An endpoint for that returns a list of steps to be incompleted / completed to get started with their\nModern Dropship account. Not all steps are required.","operationId":"getMeGettingStarted","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/models.GettingStartedResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"summary":"Get remaining steps for current company's onboarding.","tags":["User"]}},"/documents":{"get":{"description":"An endpoint to list documents relevant to your company stored in our platform (eg. legal agreements, EDI documents, company logos, CSV uploads). Documents are returned in order of those most recently created.","operationId":"listDocuments","parameters":[{"description":"The page number of products to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of products to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"A comma-separated list of tags that should be included.","in":"query","name":"tags","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/models.Document"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List documents","tags":["Document"]}},"/documents/{document_id}":{"delete":{"description":"An endpoint that returns the metadata and content for a document.","parameters":[{"description":"Document ID","in":"path","name":"document_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"summary":"Get document","tags":["Document"]},"get":{"description":"Retrieves the metadata and content of a document by its ID. The metadata is provided as a JSON object and the document content is streamed as binary data.","operationId":"getDocument","parameters":[{"description":"Document ID","in":"path","name":"document_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"description":"attachment; filename=\\\"example.doc\\","schema":{"type":"string"}},"Content-Type":{"description":"multipart/form-data","schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get Document","tags":["Document"]}},"/documents/images":{"post":{"description":"An endpoint used to upload images to the backend.","operationId":"uploadImage","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The image to be uploaded","type":"string","format":"binary"}},"required":["file"]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.DocumentResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Upload image","tags":["Document"]}},"/invoices":{"get":{"description":"An endpoint for listing invoices.","operationId":"getInvoices","parameters":[{"description":"The page number of invoices to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of invoices to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}},{"description":"The desired state to filter invoices by.","in":"query","name":"state","schema":{"type":"string","enum":["draft","open","paid","void"]}},{"description":"The desired seller company ID to filter invoices by.","in":"query","name":"sellerCompanyId","schema":{"type":"string"}},{"description":"The desired buyer company ID to filter invoices by.","in":"query","name":"buyerCompanyId","schema":{"type":"string"}},{"description":"Search by order reference (line item), invoice id, codes, source id, or partner name.","in":"query","name":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/core.Invoice"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List invoices","tags":["Invoice"]}},"/invoices/{invoice_id}":{"get":{"description":"An endpoint for retrieving an invoice by its ID.","operationId":"getInvoiceByID","parameters":[{"description":"ID of the invoice","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.Invoice"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get invoice by ID","tags":["Invoice"]}},"/partners":{"get":{"description":"An endpoint for getting partners.","operationId":"getPartners","parameters":[{"description":"The page number of results to return. Note this is a zero-based index.","in":"query","name":"page","schema":{"type":"integer"}},{"description":"The number of results per page. Max is 250.","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Show partners who have completed the onboarding steps.","in":"query","name":"completed","schema":{"type":"boolean"}},{"description":"Provide the getting started status within the partner. If false, partners[0].gettingStarted will be null.","in":"query","name":"showOnboardingStatus","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/core.PartnerAPI"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List partners","tags":["Partner"]},"post":{"description":"An endpoint for creating new partners. If you are a seller, please provide an email and price list ID. If you are a buyer, only an email is required.","operationId":"postPartnership","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/partners.InvitedPartner"}}},"description":"An object containing a partnership","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.PartnerAPI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create partner","tags":["Partner"]}},"/partners/{partner_id}":{"delete":{"description":"An endpoint for deleting a partner.","operationId":"deletePartner","parameters":[{"description":"The ID of the partner to delete","in":"path","name":"partner_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.deletePartnerResponse"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete partner","tags":["Partner"]},"get":{"description":"An endpoint that returns specific details about a partnership between a buyer and seller.","operationId":"getPartner","parameters":[{"description":"The ID of the partner.","in":"path","name":"partner_id","required":true,"schema":{"type":"string"}},{"description":"Billed is a boolean","in":"query","name":"billed","schema":{"type":"string"}},{"description":"ID of the buyer company","in":"query","name":"buyerCompanyObjectID","schema":{"type":"string"}},{"description":"Represented by startTime in filtering","in":"query","name":"createdAfter","schema":{"type":"string"}},{"description":"Represented by endTime in filtering","in":"query","name":"createdBefore","schema":{"type":"string"}},{"description":"Flagged is a boolean","in":"query","name":"flagged","schema":{"type":"string"}},{"description":"Posted is a boolean","in":"query","name":"posted","schema":{"type":"string"}},{"description":"ID of the seller company","in":"query","name":"sellerCompanyObjectID","schema":{"type":"string"}},{"description":"IDs of the seller company (multiple)","in":"query","name":"sellerCompanyObjectIDs","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Shipped is a boolean","in":"query","name":"shipped","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.PartnerAPI"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get partner","tags":["Partner"]},"patch":{"description":"An endpoint for partially updating partners.","operationId":"patchPartnerByID","parameters":[{"description":"ID of the partner","in":"path","name":"partner_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/partners.PartnerUpdate"}}},"description":"The partner fields to be updated","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.PartnerAPI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update partner","tags":["Partner"]}},"/partners/{partner_id}/reinvite":{"post":{"description":"resends an invitation email to an incomplete partnership","operationId":"reInvitePartner","parameters":[{"description":"The ID of the partner to reinvite","in":"path","name":"partner_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Reinvite partner","tags":["Partner"]}},"/partners/companyId/{company_id}":{"get":{"description":"Get a partner based on the corresponding company ID, if you are a seller, the company ID is a buyer you're partnered with, if you are a buyer, the company ID is a seller you're partnered with","operationId":"getPartnerByCompanyID","parameters":[{"description":"The ID of the company.","in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Billed is a boolean","in":"query","name":"billed","schema":{"type":"string"}},{"description":"ID of the buyer company","in":"query","name":"buyerCompanyObjectID","schema":{"type":"string"}},{"description":"Represented by startTime in filtering","in":"query","name":"createdAfter","schema":{"type":"string"}},{"description":"Represented by endTime in filtering","in":"query","name":"createdBefore","schema":{"type":"string"}},{"description":"Flagged is a boolean","in":"query","name":"flagged","schema":{"type":"string"}},{"description":"Posted is a boolean","in":"query","name":"posted","schema":{"type":"string"}},{"description":"ID of the seller company","in":"query","name":"sellerCompanyObjectID","schema":{"type":"string"}},{"description":"IDs of the seller company (multiple)","in":"query","name":"sellerCompanyObjectIDs","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Shipped is a boolean","in":"query","name":"shipped","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.PartnerAPI"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get partner by companyId","tags":["Partner"]}},"/sftp":{"post":{"description":"An endpoint for creating SFTP credentials.","operationId":"postSFTPCredentials","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.createSFTPUserCredentials"}}},"description":"The SFTP credentials","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.sftpUserCredentialsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create SFTP credentials","tags":["Company"]}},"/sftp/{username}":{"delete":{"description":"An endpoint for deleting SFTP credentials.","operationId":"deleteSFTPUserByUsername","parameters":[{"description":"Username associated with the SFTP credentials to be deleted","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.sftpUserCredentialsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete SFTP credentials","tags":["Company"]},"patch":{"description":"An endpoint for updating an SFTP user's password.","operationId":"patchSFTPUserByUsername","parameters":[{"description":"Username associated with the SFTP credentials to be updated","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.updateSFTPUserCredentials"}}},"description":"New password for updating SFTP credentials.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.sftpUserCredentialsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update SFTP credentials","tags":["Company"]}},"/shipping/methods":{"get":{"description":"An endpoint for listing shipping methods.","operationId":"getShippingMethods","parameters":[{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/shipping.Method"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List shipping methods","tags":["Shipping Methods"]},"post":{"description":"Create makes a new shipping method for the current company. These will be shown to your partners so see what shipping methods you support.","operationId":"createShippingMethod","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.ShippingMethodParams"}}},"description":"The fields needed to create a shipping method.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/shipping.Method"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create makes a new shipping method for the current company.","tags":["Shipping Methods"]}},"/shipping/methods/{shipping_method_id}":{"delete":{"description":"An endpoint to delete a shipping method.","operationId":"deleteShippingMethod","parameters":[{"description":"ID of the shipping method to delete","in":"path","name":"shipping_method_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Deletes the shipping method with the given ID.","tags":["Shipping Methods"]},"patch":{"description":"An endpoint for updating details on a shipping method, like the max days or carrier names.","operationId":"updateShippingMethod","parameters":[{"description":"ID of the shipping method to update","in":"path","name":"shipping_method_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.ShippingMethodParams"}}},"description":"Shipping method fields to update","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/shipping.Method"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Updates the shipping method with the given ID.","tags":["Shipping Methods"]}},"/users/{user_id}":{"patch":{"description":"An endpoint for partially updating users.","operationId":"patchUserByID","parameters":[{"description":"ID of the user","in":"path","name":"user_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users.UserUpdate"}}},"description":"The user fields to be updated","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.User"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update user","tags":["User"]}},"/users/{user_id}/roll":{"post":{"description":"An endpoint to roll the supplied API key.","operationId":"rollUserAPIKey","parameters":[{"description":"ID of the user","in":"path","name":"user_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.rollAPIKeyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Roll API key","tags":["User"]}},"/webhooks":{"get":{"description":"This endpoint returns all webhook configurations associated with the current account as a paged result set.","operationId":"getAllWebhookConfigurations","parameters":[{"description":"The page number of resources to return.","in":"query","name":"page","schema":{"type":"integer","minimum":0,"default":0}},{"description":"The number of resources to return.","in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":250,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.responseConfiguration"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List webhook configurations","tags":["Webhook"]},"post":{"description":"The endpoint allows you to create a new webhook configuration to subscribe to topics and have events sent to a target URL.\n\n**Newly created webhooks are by default deactived (`active=false`) to prevent events being sent to webhooks that aren't ready.\nAfter creating a new webhook make sure to update it and set `active=true`**","operationId":"createNewWebhookConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.RequestCreateConfiguration"}}},"description":"A new webhook configuration","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.responseConfiguration"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Create webhook configuration","tags":["Webhook"]}},"/webhooks/{id}":{"get":{"description":"This endpoint gets a single webhook configuration specified by the webhook ID in the path","operationId":"getWebhookConfigurationByID","parameters":[{"description":"The object ID of the webhook confguration to be returned","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.responseConfiguration"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Get webhook configuration","tags":["Webhook"]},"patch":{"description":"Updates the webhook configuration specified by the path with the request body","operationId":"updateWebhookConfiguration","parameters":[{"description":"The object ID of the webhook confguration to be returned","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/core.RequestUpdateConfiguration"}}},"description":"A new webhook configuration","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"$ref":"#/components/schemas/core.responseConfiguration"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"Update webhook configuration","tags":["Webhook"]}},"/webhooks/topics":{"get":{"description":"This endpoint returns a list of all the different topics available for webhooks to subscribe to.","operationId":"getListOfWebhookTopics","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api.APIWrapper"},{"properties":{"data":{"items":{"type":"string"},"type":"array"}},"type":"object"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}],"summary":"List webhook topics","tags":["Webhook"]}}},"servers":[{"url":"//api.moderndropship.com"}],"components":{"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"api.APIWrapper":{"properties":{"data":{},"error":{"items":{"$ref":"#/components/schemas/api.ErrorMessage"},"type":"array"},"hasMore":{"type":"boolean"},"next":{"type":"string"},"previous":{"type":"string"}},"type":"object"},"api.ErrorMessage":{"properties":{"message":{"type":"string"}},"type":"object"},"api.ErrorResponse":{"properties":{"error":{"type":"string"}},"type":"object"},"base.MgoMoney":{"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"type":"object"},"consumableactions.CreateActionResponse":{"properties":{"id":{"type":"string"}},"type":"object"},"consumableactions.CreateActionTemplateBody":{"properties":{"cardText":{"type":"string"},"cardTitle":{"type":"string"},"documentId":{"description":"For kind=hello_sign, this is the base contract that all future agreements are created from.","type":"string"},"emailMessage":{"type":"string"},"emailSubject":{"type":"string"},"kind":{"type":"string"},"optionalDocId":{"type":"string"},"required":{"type":"boolean"},"terms":{"allOf":[{"$ref":"#/components/schemas/models.TermsAndConditions"}],"description":"For kind=term_and_conditions, maps a PDF field to a price list field"}},"type":"object"},"consumableactions.CreateConsumableActionBody":{"properties":{"agreementId":{"type":"string"},"cardText":{"type":"string"},"cardTitle":{"type":"string"},"documentId":{"type":"string"},"kind":{"description":"Kind and Type are same thing. On the UI, it may read type.","type":"string"},"optionalDocId":{"description":"Optional document included with the action. For kind=file_upload, this will be template.","type":"string"},"partnerId":{"description":"Partner id of the who it is being mapped to. This is currently required since users create actions via partners.","type":"string"},"required":{"type":"boolean"},"terms":{"allOf":[{"$ref":"#/components/schemas/models.TermsAndConditions"}],"description":"Terms holds information in a T&Cs agreement that corresponds to a Convictional price list field"}},"type":"object"},"consumableactions.UpdateActionTemplateBody":{"properties":{"applyToNewPartners":{"type":"boolean"},"cardText":{"type":"string"},"cardTitle":{"type":"string"},"required":{"type":"boolean"}},"type":"object"},"consumableactions.UpdateConsumableActionBody":{"properties":{"cardText":{"type":"string"},"cardTitle":{"type":"string"},"required":{"type":"boolean"}},"type":"object"},"consumableactions.UpdateStatusBody":{"properties":{"documentID":{"type":"string"},"status":{"type":"string"}},"type":"object"},"core.APIEasyPostSettings":{"properties":{"connected":{"type":"boolean"}},"type":"object"},"core.AuthMeResponse":{"properties":{"company":{"allOf":[{"$ref":"#/components/schemas/core.Company"}],"description":"The company to which the user belongs."},"flags":{"additionalProperties":{"type":"boolean"},"description":"Flags that are set for the user/company","type":"object"},"subscriptions":{"allOf":[{"$ref":"#/components/schemas/core.SubscriptionInfo"}],"description":"Information about whether the company has had previous subscriptions"},"user":{"allOf":[{"$ref":"#/components/schemas/core.User"}],"description":"The currently logged in user."}},"type":"object"},"core.Company":{"properties":{"_id":{"description":"Primary key. Use this one.","type":"string"},"activeAuth":{"additionalProperties":true,"type":"object"},"balance":{"allOf":[{"$ref":"#/components/schemas/models.Balance"}],"description":"Balance (payment provider) integration data for this company"},"batchInvoicingSettings":{"allOf":[{"$ref":"#/components/schemas/models.BatchInvoicingSettings"}],"description":"Retailer-level batch invoicing configuration for Stripe batching"},"bigCommerce":{"$ref":"#/components/schemas/models.BigCommerceAuth"},"billing":{"allOf":[{"$ref":"#/components/schemas/github_com_convictional_backend_domains_address.Address"}],"description":"Address that appears on packing slips                // Migrate: Planned - to Locations w/ Type=billing"},"billingEmail":{"description":"Email for invoices/billing notifications; falls back to ContactEmail if unset","type":"string"},"cancellationSettings":{"allOf":[{"$ref":"#/components/schemas/models.CancellationSettings"}],"description":"Cancellation settings for the company"},"commerceType":{"allOf":[{"$ref":"#/components/schemas/models.CommerceType"}],"description":"\"buyer\" or \"seller\""},"contactEmail":{"description":"General email available to partners          // Must be set by dev for now","type":"string"},"created":{"description":"date this company was created","type":"string"},"crmEmail":{"description":"BCC email for the company CRM","type":"string"},"dataExports":{"allOf":[{"$ref":"#/components/schemas/models.DataExports"}],"description":"Settings for data exports from Convictional"},"defaultBillingSettings":{"allOf":[{"$ref":"#/components/schemas/models.CompanyDefaultBillingSettings"}],"description":"What billing settings should be applied to new partnerships?"},"domains":{"description":"Array of domains associated with the company","items":{"$ref":"#/components/schemas/models.Domain"},"type":"array"},"easypost":{"$ref":"#/components/schemas/core.APIEasyPostSettings"},"ediData":{"allOf":[{"$ref":"#/components/schemas/models.EDIData"}],"description":"EDI information for the company"},"enableOrderPayments":{"description":"Should we allow payments involving this company?","type":"boolean"},"enableShippingLinesShopify":{"description":"Impacts order posting somehow                        // Migrate: Planned - to Shopify Metafields","type":"boolean"},"externalSFTP":{"$ref":"#/components/schemas/models.ExternalSFTPAuth"},"flags":{"allOf":[{"$ref":"#/components/schemas/models.CompanyFlags"}],"description":"Flags relating to company settings"},"gateway":{"allOf":[{"$ref":"#/components/schemas/models.PayoutAccountType"}],"description":"The integration used by the seller to get paid"},"gettingStarted":{"allOf":[{"$ref":"#/components/schemas/models.GettingStarted"}],"description":"Onboarding tracker - tracks the current status of the included states"},"inventoryPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Inventory platform of company - usually matches productPlatform"},"legacyCompanyId":{"description":"Primary key, also. DO NOT EDIT THIS VALUE ON DOCUMENTS. Exists because of legacy dependencies. New code should only refer to company.ID and migrating old code is encouraged.","type":"string"},"legalName":{"description":"E.g. \"Convictional, Inc.\"","type":"string"},"locations":{"description":"List of locations associated with the company. A company must have at least one billing address (once a billing address has been added).","items":{"$ref":"#/components/schemas/github_com_convictional_backend_domains_address.Address"},"type":"array"},"logoId":{"description":"FK: Document.ID","type":"string"},"magento2":{"$ref":"#/components/schemas/models.Magento2Auth"},"marketplaceEarnMargin":{"description":"Total active products and available to marketplace of a company","type":"number"},"marketplaceSettings":{"$ref":"#/components/schemas/models.MarketplaceSettings"},"maxReturnRate":{"description":"Maximum return rate expectation for their partners","type":"number"},"maxShipTime":{"description":"Maximum ship time expectation for their partners, in hours","type":"number"},"merchandisingSettings":{"allOf":[{"$ref":"#/components/schemas/models.MerchandisingSettings"}],"description":"Configuration settings for merchandising"},"metafieldSchemas":{"allOf":[{"$ref":"#/components/schemas/models.MetafieldSchemas"}],"description":"Pre-defined metafields for company resources // To be used as we add more support for metafields"},"metafields":{"allOf":[{"$ref":"#/components/schemas/models.Metafields"}],"description":"User/integration defined fields              // Migrate: Planned"},"name":{"description":"E.g. \"Convictional\"","type":"string"},"orderPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Order platform of company"},"orderPlatformActive":{"type":"boolean"},"orderTagValues":{"description":"Custom tag values to attach to orders pushed to seller platforms","items":{"type":"string"},"type":"array"},"paymentMethodUpdated":{"description":"When the PaymentMethod was last updated              // Migrate: Planned - to Stripe Metafields","type":"string"},"plan":{"allOf":[{"$ref":"#/components/schemas/models.CompanyPlan"}],"description":"plan with Convictional"},"premierBrandLogo":{"description":"The logo to be displayed in Premier brands section","type":"string"},"premierBrandOrdering":{"description":"The sorting order for Premier brands","type":"integer"},"privacy":{"allOf":[{"$ref":"#/components/schemas/models.CompanyPrivacy"}],"description":"Privacy flags"},"productPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Product platform of company"},"productPlatformActive":{"type":"boolean"},"quarantineState":{"allOf":[{"$ref":"#/components/schemas/models.QuarantineState"}],"description":"Quarantine"},"relatedCustomer":{"description":"Calculated field for which customer (squad) bucket it falls into.","type":"string"},"returnsSettings":{"allOf":[{"$ref":"#/components/schemas/models.ReturnsSettings"}],"description":"Returns settings for the company"},"sftp":{"allOf":[{"$ref":"#/components/schemas/models.SFTPSettings"}],"description":"SFTP settings for the company"},"shippingSettings":{"allOf":[{"$ref":"#/components/schemas/models.ShippingSettings"}],"description":"Shipping settings for the company"},"shopify":{"allOf":[{"$ref":"#/components/schemas/models.ShopifySettings"}],"description":"Integrations"},"stripeAccountId":{"description":"Stripe account ID of a seller who connected Stripe   // Migrate: Planned - to Stripe Metafields","type":"string"},"stripeCustomerId":{"description":"Stripe customer ID of a buyer used for invoicing     // Migrate: Planned - to Stripe Metafields","type":"string"},"stripeUSCustomerId":{"description":"Stripe US connected account customer ID","type":"string"},"syncing":{"allOf":[{"$ref":"#/components/schemas/models.CompanySyncing"}],"description":"Workers flags"},"timeZone":{"type":"string"},"updated":{"description":"date this company was updated","type":"string"},"url":{"description":"URL of the company website","type":"string"},"users":{"description":"List of users that belong to a company","items":{"$ref":"#/components/schemas/models.CompanyUser"},"type":"array"},"webhooks":{"description":"Tracks registered webhooks","items":{"$ref":"#/components/schemas/models.Webhook"},"type":"array"},"woocommerce":{"$ref":"#/components/schemas/models.WooCommerceSettings"}},"type":"object"},"core.DocumentResponse":{"properties":{"documentId":{"example":"60ca4951388d07477299ed9c","type":"string"}},"type":"object"},"core.Email":{"properties":{"address":{"description":"The user's email address.","example":"john.doe@sample.ecom","type":"string"},"verified":{"description":"Whether or not the email address has been verified.","example":true,"type":"boolean"}},"type":"object"},"core.Invoice":{"properties":{"amountPaidCents":{"description":"The total value of the invoice that has been paid in cents.","example":500,"type":"integer"},"amountRemainingCents":{"description":"The total unpaid value of the invoice in cents.","example":500,"type":"integer"},"amountTotalCents":{"description":"The total value of the invoice in cents.","example":1000,"type":"integer"},"buyerCode":{"description":"Buyer's specific code for the invoice.","example":"7101Z","type":"string"},"buyerCompanyId":{"description":"Modern Dropship ID for the Buyer Company. Read Only.","example":"573ce4451e02f4bae78788aa","type":"string"},"created":{"description":"The time the invoice was created. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"currency":{"description":"Currency code (e.g. CAD).","example":"USD","type":"string"},"download":{"description":"Download link to the invoice from integrations we utilize, like Stripe","example":"https://pay.stripe.com/invoice/acct_XXXX...","type":"string"},"dueDate":{"description":"The time the invoice is due.","example":"2020-05-01T19:35:00.000Z","type":"string"},"finalizedDate":{"description":"The time that the invoice was finalized.","example":"2020-05-01T19:35:00.000Z","type":"string"},"hostedURL":{"description":"A URL to the version of the invoice hosted by the seller's payment platform.","type":"string"},"id":{"description":"The Modern Dropship invoice ID. Read only.","example":"573ce4451e02f4bae78788aa","type":"string"},"items":{"description":"The line items on the invoice.","items":{"$ref":"#/components/schemas/core.InvoiceItem"},"type":"array"},"metafields":{"$ref":"#/components/schemas/handler.Metafields"},"orderFee":{"allOf":[{"$ref":"#/components/schemas/models.PerOrderFee"}],"description":"The fee charged for the order"},"paidDate":{"description":"The time the invoice was paid.","example":"2020-05-01T19:35:00.000Z","type":"string"},"posted":{"description":"Indicates if the invoice has been posted to the buyer's platform.","example":true,"type":"boolean"},"postedDate":{"description":"The time that the invoice was posted","example":"2020-05-01T19:35:00.000Z","type":"string"},"sellerCode":{"description":"Seller's specific code for the invoice.","example":"ABC123","type":"string"},"sellerCompanyId":{"description":"Modern Dropship ID for the Seller Company. Read Only.","example":"573ce4451e02f4bae78788aa","type":"string"},"source":{"description":"Source of the invoice.","example":"stripe","type":"string"},"status":{"description":"Indicates the current status of the invoice.","enum":["draft","open","paid","void"],"example":"open","type":"string"},"taxes":{"description":"The tax line items on the invoice.","items":{"$ref":"#/components/schemas/core.TaxItem"},"type":"array"},"toBePostedOnDate":{"description":"The date that this invoice is to be posted on if delayed billing is required. Default to zero time if delayed billing is not required","example":"2023-03-17T19:35:00.000Z","type":"string"},"updated":{"description":"The time the invoice was updated. Read Only.","example":"2020-05-01T19:35:00.000Z","type":"string"},"voidReason":{"description":"The reason the invoice was voided","example":"The items were cancelled","type":"string"}},"type":"object"},"core.InvoiceItem":{"properties":{"_id":{"description":"ID of the item for the invoice.","example":"6023f23334ca2118255da096","type":"string"},"amountCents":{"description":"The amount of referenced item, in cents.","example":1600,"type":"integer"},"reference":{"description":"What this item is refenced from.","example":"order","type":"string"},"referenceId":{"description":"Referenced type Modern Dropship ID. Read Only.","example":"6023f23334ca2118255da096","type":"string"}},"type":"object"},"core.MembershipResponse":{"properties":{"apiKey":{"description":"The user's APIKey for the company.","type":"string"},"commerceType":{"allOf":[{"$ref":"#/components/schemas/models.CommerceType"}],"description":"The commerce type of the company."},"companyName":{"description":"The name of the company.","type":"string"},"companyObjectId":{"description":"The ID of the company.","type":"string"},"rateLimit":{"description":"The user's API key rate limit in requests per second for the Convictional API","type":"number"},"role":{"allOf":[{"$ref":"#/components/schemas/users.MemberRole"}],"description":"The user's role in the company."},"url":{"description":"The URL of the company.","type":"string"}},"type":"object"},"core.OnboardingAttributes":{"properties":{"commerceType":{"description":"The commerce type given during onboarding.","example":"buyer","type":"string"},"companyName":{"description":"The company name given during onboarding.","example":"Buy'N'Large","type":"string"},"companyUrl":{"description":"The company URL given during onboarding.","example":"store.com","type":"string"},"firstName":{"description":"The first name given during onboarding.","example":"John","type":"string"},"lastName":{"description":"The last name given during onboarding.","example":"Doe","type":"string"},"platform":{"description":"The platform given during onboarding.","example":"shopify","type":"string"},"referralCompanyId":{"description":"The referring company ID during onboarding.","example":"other-company-com","type":"string"},"source":{"description":"The source given during onboarding.","example":"stripe","type":"string"},"storeUrl":{"description":"The Store URL given during onboarding.","example":"store.myshopify.com","type":"string"},"temporaryTokenId":{"description":"The ID of the temporarily stored access token for a store. Used if the account was created through the app installation process.","type":"string"}},"type":"object"},"core.PartnerAPI":{"properties":{"_id":{"description":"The ID of the partner.","example":"5f10b1c80f7a22222293145f","type":"string"},"active":{"description":"Indicates whether the partnership is active.","example":true,"type":"boolean"},"autoAcceptReturns":{"description":"Whether the seller will automatically accept requested returns","example":false,"type":"boolean"},"averageReturnRate":{"description":"The percentage of returned orders over the given time period. Default is last 30 days. Value between 0 and 1.","example":0.1,"type":"number"},"averageShipTime":{"description":"The average time in hours it takes the seller to ship an order, based on a given time period. Default is last 30 days.","example":60.3,"type":"number"},"billing":{"description":"If true, invoices will be automatically posted to a payment platform. This field will be deprecated in favor of billingSettings.postInvoices.","example":true,"type":"boolean"},"billingSettings":{"$ref":"#/components/schemas/core.PartnerBillingSettingsAPI"},"buyerAssignedCode":{"description":"Assigned to the seller or partnership by the buyer.","example":"Supplier-ABC","type":"string"},"buyerCompanyId":{"description":"The legacy company ID of the buyer.","example":"buyer-com","type":"string"},"buyerCompanyObjectId":{"description":"The ID of the buyer company.","example":"5f10b1c80f7a222222931422","type":"string"},"buyerName":{"description":"The name of the buyer company associated with this partner. Only populated when called by a seller.","example":"Marketplace XYZ","type":"string"},"buyerOnboardingCompleted":{"description":"The buyer has completed all onboarding steps onto Modern Dropship.","example":false,"type":"boolean"},"buyerOrderPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Represents the Buyers Order Management System (OMS)","example":"Shopify"},"buyerProductPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Represents the Buyers Product Information Management (PIM) system","example":"Shopify"},"companyId":{"description":"The legacy company ID of the seller.","example":"seller-com","type":"string"},"created":{"description":"The timestamp of creation.","example":"2020-07-01T13:41:00.000+0400","type":"string"},"custom":{"items":{"$ref":"#/components/schemas/models.Custom"},"type":"array"},"deletedAt":{"description":"The timestamp of deletion.","example":"2020-07-01T13:41:00.000+0400","type":"string"},"effectiveMaxReturnRate":{"description":"The effective maximum expected return rate for this partner, as a percentage.","example":50,"type":"number"},"effectiveMaxShipTime":{"description":"The effective maximum expected ship time for this partner, in hours.","example":72,"type":"number"},"effectiveShippingSettings":{"allOf":[{"$ref":"#/components/schemas/models.ShippingSettings"}],"description":"With company and partner settings taken into account, the effective shipping settings for this partner."},"email":{"description":"Contact email for the other side of the partnership (from the counterparty company's contactEmail).","example":"seller@example.com","type":"string"},"gettingStarted":{"$ref":"#/components/schemas/models.GettingStartedResponse"},"invited":{"description":"Has the invite email been sent?","example":true,"type":"boolean"},"maxReturnRate":{"description":"The maximum expected return rate for this partner, as a percentage.","example":50,"type":"number"},"maxShipTime":{"description":"The maximum expexcted ship time for this partner, in hours.","example":72,"type":"number"},"merchandisingSettings":{"allOf":[{"$ref":"#/components/schemas/models.MerchandisingSettings"}],"description":"Configuration settings for merchandising at partner level. Takes precedence over company level settings if present."},"metafields":{"$ref":"#/components/schemas/models.Metafields"},"perOrderFeeSettings":{"allOf":[{"$ref":"#/components/schemas/partners.PerOrderFeeSettings"}],"description":"Configuration settings for a per order fee"},"priceListName":{"description":"Name of the price list assigned to this customer.","example":"Wholesale Pricing","type":"string"},"pricingId":{"description":"ID of the price list assigned to this customer.","example":"abc123","type":"string"},"pricingMarginMax":{"description":"Maximum margin set for the price list assigned to this customer.","example":20,"type":"number"},"pricingMarginMin":{"description":"Minimum margin set for the price list assigned to this customer.","example":10,"type":"number"},"reference":{"description":"The email address of the new partner, used when inviting a partner that is new to Modern Dropship.","type":"string"},"requireFulfillmentTrackingInfo":{"description":"If true, sellers are required to provide tracking information","example":false,"type":"boolean"},"retailerInvoicing":{"allOf":[{"$ref":"#/components/schemas/core.RetailerInvoicingAPI"}],"description":"Retailer-level batch invoicing settings visible to suppliers/partners"},"sellerAssignedCode":{"description":"Assigned to the buyer or partnership by the seller.","example":"Customer-ABC","type":"string"},"sellerCompanyId":{"description":"The legacy company ID of the seller.","example":"seller-com","type":"string"},"sellerCompanyObjectId":{"description":"The ID of the seller company.","example":"5f10b1c80f7a222222931411","type":"string"},"sellerName":{"description":"The name of the seller company associated with this partner. Only populated when called by a buyer.","example":"Fred's Shoe Co.","type":"string"},"sellerOnboardingCompleted":{"description":"The seller has completed all onboarding steps onto Modern Dropship.","example":false,"type":"boolean"},"sellerOrderPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Represents the Sellers Order Management System (OMS)","example":"Shopify"},"sellerProductPlatform":{"allOf":[{"$ref":"#/components/schemas/models.Platform"}],"description":"Represents the Sellers Product Information Management (PIM) system","example":"Shopify"},"shippingMethods":{"items":{"$ref":"#/components/schemas/shipping.Method"},"type":"array"},"shippingSettings":{"allOf":[{"$ref":"#/components/schemas/models.ShippingSettings"}],"description":"Configuration settings for shipping at partner level. Takes precedence over company level settings if present."},"syncSellerCompareAtPrice":{"description":"Whether to sync compare at price from the seller (Shopify Only)","example":false,"type":"boolean"},"updated":{"description":"The timestamp of last update.","example":"2020-07-01T13:41:00.000+0400","type":"string"},"website":{"description":"Website domain for the other side of the partnership (from the counterparty company's url).","example":"nexus.co","type":"string"}},"type":"object"},"core.PartnerBillingSettingsAPI":{"properties":{"autoTax":{"description":"If true, automatically generated taxes are added to automatic invoices.","example":true,"type":"boolean"},"enablePaymentTerms":{"description":"If true, payment terms are enabled","example":true,"type":"boolean"},"generateOrderInvoices":{"description":"If true, invoices are automatically generated for shipped orders.","example":true,"type":"boolean"},"invoicePoster":{"description":"What integration will be used to handle invoice posting (computed)","type":"string"},"invoicePosterReason":{"description":"Why is that integration being used (computed)","type":"string"},"paymentTerms":{"allOf":[{"$ref":"#/components/schemas/models.PaymentTerms"}],"description":"Payment terms settings, only useful if payment terms are enabled"},"postInvoices":{"description":"If true, invoices will be automatically posted to a payment platform. This field is replacing the `billing` field and will always be equal to it.","example":true,"type":"boolean"},"preferredInvoicePoster":{"description":"When both Stripe and Balance available: \"stripe\" | \"balance\" | \"\" (default Stripe)","type":"string"}},"type":"object"},"core.RequestCreateConfiguration":{"description":"Defines the settings available and required to subscribe to one or more Modern Dropship webhook topics. Please read more on webhooks [here](https://developers.moderndropship.com/docs/webhooks)","properties":{"limiterBurst":{"default":0,"description":"The highest burst rate of requests used by the limiter to determine delivery speed of new topics to the target URL.\nMust be smaller than or equal to the limiterRate defined above.\nMust be a positive integer. Default value is 0 which means NO LIMIT","example":5,"minimum":1,"type":"integer"},"limiterRate":{"default":0,"description":"The limiter rate used to thorttle topic delivery to the target URL.\nMust be a positive integer. Default value is 0 which means NO LIMIT","example":5,"minimum":1,"type":"integer"},"secrets":{"description":"A list of secrets used to create Convictional-Signature headers to verify webhook data integrety.\nYou are able to attach more than one secret to a webhook configuration and both validation tokens will be sent.\nThis is to assit with token renewals so that your webhook can migrate from one token to the other without any\ndowntime.","items":{"$ref":"#/components/schemas/core.RequestCreateSecret"},"type":"array"},"targetUrl":{"description":"The full URL to which new webhook events are POSTed","example":"https://www.moderndropship.com/fake/webhook/consumer","type":"string"},"topics":{"description":"List of topics that the URL specified by this configuration should receive","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["secrets","targetUrl","topics"],"type":"object"},"core.RequestCreateSecret":{"properties":{"expiresDate":{"description":"Date that the secret expires. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"},"secret":{"description":"The secret used to verify the integrity of the data sent by webhooks.\nThis can only be set at create time. If you need to edit or change a secret you must set the expiry date\nof the one you want to edit in the near future and create a new one with the correct Secret. The system\nwill attach both to your request so you will still be able to validate against the correct one.\nThis is to prevent secrets from changing unexpectedly and breaking the validation step.","example":"s8*FL0f7f#l&(09ow3asd3fDWZX0098","minLength":20,"type":"string"}},"required":["expiresDate","secret"],"type":"object"},"core.RequestUpdateConfiguration":{"description":"Defines the settings available and required to subscribe to one or more Modern Dropship webhook topics. Please read more on webhooks [here](https://developers.moderndropship.com/docs/webhooks)","properties":{"active":{"type":"boolean"},"limiterBurst":{"default":0,"description":"The highest burst rate of requests used by the limiter to determine delivery speed of new topics to the target URL.\nMust be smaller than or equal to the limiterRate defined above.\nMust be a positive integer. Default value is 0 which means NO LIMIT","example":5,"minimum":1,"type":"integer"},"limiterRate":{"default":0,"description":"The limiter rate used to thorttle topic delivery to the target URL.\nMust be a positive integer. Default value is 0 which means NO LIMIT","example":5,"minimum":1,"type":"integer"},"secrets":{"description":"A list of secrets used to create Convictional-Signature headers to verify webhook data integrety.\nYou are able to attach more than one secret to a webhook configuration and both validation tokens will be sent.\nThis is to assit with token renewals so that your webhook can migrate from one token to the other without any\ndowntime.","items":{"$ref":"#/components/schemas/core.RequestUpdateSecret"},"type":"array"},"targetUrl":{"description":"The full URL to which new webhook events are POSTed","example":"https://www.moderndropship.com/fake/webhook/consumer","type":"string"},"topics":{"description":"// List of topics that the URL specified by this configuration should receive","items":{"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"core.RequestUpdateSecret":{"properties":{"expiresDate":{"description":"Date that the secret expires. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"},"id":{"description":"The globally unique, internal Modern Dropship object identifier for this item.","example":"62265540bfa764a8442e4b35","type":"string"},"secret":{"description":"The secret used to verify the integrity of the data sent by webhooks.\nThis can only be set at create time. If you need to edit or change a secret you must set the expiry date\nof the one you want to edit in the near future and create a new one with the correct Secret. The system\nwill attach both to your request so you will still be able to validate against the correct one.\nThis is to prevent secrets from changing unexpectedly and breaking the validation step.","example":"s8*FL0f7f#l&(09ow3asd3fDWZX0098","minLength":20,"type":"string"}},"type":"object"},"core.RetailerInvoicingAPI":{"properties":{"batchEnabled":{"example":false,"type":"boolean"},"numBillingDelayDays":{"example":7,"type":"integer"},"periodDays":{"example":14,"type":"integer"}},"type":"object"},"core.ShippingMethodParams":{"properties":{"carrierNames":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"maxDays":{"type":"integer"}},"type":"object"},"core.SubscriptionInfo":{"properties":{"hasCA":{"description":"Whether the company has had a subscription in CA.","example":true,"type":"boolean"},"hasUS":{"description":"Whether the company has had a subscription in US.","example":false,"type":"boolean"}},"type":"object"},"core.TaxItem":{"properties":{"amountCents":{"description":"The amount of tax applied for this type of tax in cents.","example":1234,"type":"integer"},"amountPercent":{"description":"The amount of tax applied for this type of tax in percent.","example":0.05,"type":"number"},"type":{"description":"The type of tax applied to order, currently `GS` and `SP` are supported.","example":"GS","type":"string"}},"type":"object"},"core.User":{"properties":{"_id":{"description":"The user ID.","example":"5a7bce11899999900f59915e","type":"string"},"apiKey":{"description":"\"A secret token used to authenticate with the Modern Dropship API. Passed in a header as: Authorization <key>\"","example":"xxx","type":"string"},"companyId":{"description":"The legacy ID of the company that this user belongs to.","example":"company-com","type":"string"},"companyObjectId":{"description":"The object ID of the user's company","example":"60c3bf46388d071b1adb2100","type":"string"},"created":{"description":"Timestamp of creation.","example":"2020-06-25T19:00:00.000+00:00","type":"string"},"emails":{"description":"A list of email addresses associated with the user.","items":{"$ref":"#/components/schemas/core.Email"},"type":"array"},"firstName":{"description":"The user's first name.","example":"John","type":"string"},"flags":{"allOf":[{"$ref":"#/components/schemas/core.UserFlags"}],"description":"Flags associated with the user"},"lastName":{"description":"The user's family name/surname.","example":"Doe","type":"string"},"memberships":{"description":"A list of companies that the user belongs to.","items":{"$ref":"#/components/schemas/core.MembershipResponse"},"type":"array"},"notifications":{"allOf":[{"$ref":"#/components/schemas/core.UserNotifications"}],"description":"Notification settings"},"onboardingAttributes":{"allOf":[{"$ref":"#/components/schemas/core.OnboardingAttributes"}],"description":"Attributes associated with the user during their onboarding"},"referralCompanyId":{"description":"The legacy ID of the company that referred this user.","example":"other-company-com","type":"string"},"superUser":{"description":"Does the user have superuser access? Modern Dropship staff only.","example":false,"type":"boolean"},"updated":{"description":"Timestamp of most recent update.","example":"2020-06-26T19:00:00.000+00:00","type":"string"}},"type":"object"},"core.UserFlags":{"properties":{"captureFrontendData":{"description":"Whether or not to record any frontend logging.","example":true,"type":"boolean"},"recordNetworkData":{"description":"Whether or not to record network calls using logrocket.","example":true,"type":"boolean"},"recordUI":{"description":"Whether or not to record UI using logrocket.","example":true,"type":"boolean"},"showMagento2":{"type":"boolean"},"showMarketplace":{"type":"boolean"},"showProductMetafields":{"description":"Whether or not to show product metafields UI features.","type":"boolean"},"showWholesale":{"description":"Whether or not to show wholesale UI features.","type":"boolean"},"stayAnonymous":{"description":"Whether or not to associate their frontend session to their user id.","example":false,"type":"boolean"}},"type":"object"},"core.UserNotifications":{"properties":{"skipActionCreated":{"description":"Whether or not to skip the notification when a TradeOps action is created for your company.","example":false,"type":"boolean"},"skipCriticalCompanyErrorCreated":{"description":"Whether or not to skip the notification when a critical TradeOps issue is created for your company.","example":false,"type":"boolean"},"skipFulfillmentPostedToBuyer":{"description":"Whether or not to skip the notification when a fulfillment is posted (for buyers).","example":false,"type":"boolean"},"skipOrderItemsCancelled":{"description":"Whether or not to skip the notification when order items are cancelled.","example":false,"type":"boolean"},"skipOrderPostedToSeller":{"description":"Whether or not to skip the notification when an order is posted (for sellers).","example":false,"type":"boolean"},"skipProductAvailableToBuyer":{"description":"Whether or not to skip the notification when new products are available (for buyers).","example":false,"type":"boolean"},"skipWeeklyOverviewEmail":{"description":"Whether or not to skip the weekly overview email.","example":false,"type":"boolean"}},"type":"object"},"core.createSFTPUserCredentials":{"properties":{"password":{"description":"Password for use in the SFTP credentials. The password must pass a password strength check.","maxLength":100,"minLength":8,"type":"string"},"username":{"description":"Username for use in the SFTP credentials. The username must be unique.","maxLength":100,"minLength":5,"type":"string"}},"required":["password","username"],"type":"object"},"core.deletePartnerResponse":{"properties":{"deleted":{"example":"60ca4951388d07477299ed9c","type":"string"}},"type":"object"},"core.responseConfiguration":{"description":"Defines the settings available and required to subscribe to one or more Modern Dropship webhook topics. Please read more on webhooks [here](https://developers.moderndropship.com/docs/webhooks)","properties":{"active":{"description":"Determines whether the webhook configuration is active and new events are POSTED to the target URL","example":true,"type":"boolean"},"created":{"description":"Date that the configuration was created. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"},"health":{"description":"Describes whether the conifiguration is considered healthy.\na configuration is unhealthy if the target URL responds with\na non HTTP 200 status code for an extended period of time (3 days) and events cannot be delivered.","enum":["healthy","failed"],"example":"healthy","type":"string"},"id":{"description":"The globally unique, internal Modern Dropship object identifier for this item.","example":"62265540bfa764a8442e4b35","type":"string"},"lastRun":{"description":"The last time an event was sent to this target URL. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"},"limiterBurst":{"default":0,"description":"The highest burst rate of requests used by the limiter to determine delivery speed of new topics to the target URL.\nMust be smaller than or equal to the limiterRate defined above.\nMust be a positive integer. Default value is 0 which means NO LIMIT","example":5,"type":"integer"},"limiterRate":{"default":0,"description":"The limiter rate used to thorttle topic delivery to the target URL.\nMust be a positive integer. Default value is 0 which means NO LIMIT","example":5,"type":"integer"},"secrets":{"description":"A list of secrets used to create Convictional-Signature headers to verify webhook data integrety.\nYou are able to attach more than one secret to a webhook configuration and both validation tokens will be sent.\nThis is to assit with token renewals so that your webhook can migrate from one token to the other without any\ndowntime.","items":{"$ref":"#/components/schemas/core.responseSecret"},"type":"array"},"targetUrl":{"description":"The full URL to which new webhook events are POSTed","example":"https://www.moderndropship.com/fake/webhook/consumer","type":"string"},"topics":{"description":"List of topics that the URL specified by this configuration should receive","items":{"type":"string"},"type":"array"},"updated":{"description":"Date that the configuration was last updated. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"}},"type":"object"},"core.responseSecret":{"properties":{"created":{"description":"Date that the validation secret was created. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"},"expiresDate":{"description":"Date that the secret expires. A RFC 3339 formatted date string.","example":"2020-06-25T19:00:00.000+00:00","format":"date-time","type":"string"},"id":{"description":"The globally unique, internal Modern Dropship object identifier for this item.","example":"62265540bfa764a8442e4b35","type":"string"},"secret":{"description":"The secret used to verify the integrity of the data sent by webhooks.\nThis can only be set at create time. If you need to edit or change a secret you must set the expiry date\nof the one you want to edit in the near future and create a new one with the correct Secret. The system\nwill attach both to your request so you will still be able to validate against the correct one.\nThis is to prevent secrets from changing unexpectedly and breaking the validation step.","example":"s8*FL0f7f#l&(09ow3asd3fDWZX0098","type":"string"}},"type":"object"},"core.rollAPIKeyResponse":{"properties":{"apiKey":{"description":"The new API key.","type":"string"}},"type":"object"},"core.sftpUserCredentialsResponse":{"properties":{"status":{"example":"SFTP credentials successfully added","type":"string"}},"type":"object"},"core.updateSFTPUserCredentials":{"properties":{"password":{"description":"Password for use in the SFTP credentials. The password must pass a password strength check.","maxLength":100,"minLength":8,"type":"string"}},"required":["password"],"type":"object"},"github_com_convictional_backend_domains_address.Address":{"properties":{"_id":{"description":"ObjectID of this address","type":"string"},"addressOne":{"description":"The primary address of this address","type":"string"},"addressTwo":{"description":"The secondary address of this address","type":"string"},"city":{"description":"The city of the address","type":"string"},"company":{"description":"The company: 'Convictional, Inc'","type":"string"},"country":{"description":"The country of the address","type":"string"},"name":{"description":"The contact name: 'John Doe'","type":"string"},"phoneNumber":{"description":"The customer's phone number.","type":"string"},"state":{"description":"The state of the address","type":"string"},"type":{"description":"Enum: 'shipping', 'billing', 'inventory', 'returns'","type":"string"},"zip":{"description":"The zip code of the address","type":"string"}},"type":"object"},"handler.Metafield":{"description":"The key of this metafield.","properties":{"description":{"description":"Describes the purpose of the metafield.","type":"string"},"updated":{"description":"Time of last update.","format":"date-time","type":"string"},"value":{"description":"The value of this metafield.","type":"string"}},"type":"object"},"handler.Metafields":{"additionalProperties":{"$ref":"#/components/schemas/handler.NamespacedMetafields"},"type":"object"},"handler.NamespacedMetafields":{"additionalProperties":{"$ref":"#/components/schemas/handler.Metafield"},"description":"A namespace to which this key belongs. Should uniquely identify the owner of this key.","type":"object"},"models.ArchiveMethod":{"enum":["DELETE","MOVE"],"type":"string","x-enum-varnames":["ArchiveMethodDelete","ArchiveMethodMove"]},"models.Balance":{"properties":{"buyerId":{"type":"string"},"paymentMethodId":{"type":"string"},"paymentMethodType":{"type":"string"},"paymentMethodUpdatedAt":{"type":"string"},"paymentMethodVerified":{"type":"boolean"},"payoutCurrency":{"description":"PayoutCurrency is the ISO 4217 code Balance uses for this vendor's payouts.\nEmpty means USD.","type":"string"},"vendorId":{"type":"string"}},"type":"object"},"models.BaseQuery":{"type":"object"},"models.BatchInvoicingConfig":{"properties":{"enabled":{"type":"boolean"},"periodDays":{"type":"integer"}},"type":"object"},"models.BatchInvoicingSettings":{"properties":{"activeConfig":{"$ref":"#/components/schemas/models.BatchInvoicingConfig"},"activeCycleStart":{"type":"string"},"nextAppliesAt":{"type":"string"},"pendingConfig":{"$ref":"#/components/schemas/models.BatchInvoicingConfig"}},"type":"object"},"models.BigCommerceAuth":{"properties":{"bigCommerceClientID":{"type":"string"},"dimensionUnit":{"type":"string"},"platform":{"$ref":"#/components/schemas/models.Platform"},"platformUrl":{"type":"string"},"weightUnit":{"type":"string"}},"type":"object"},"models.CancellationSettings":{"properties":{"syncRefundOnCancellation":{"description":"Set to true to trigger refund when orders are cancelled. Defaults to true for sellers, false for buyers.","type":"boolean"}},"type":"object"},"models.CommerceType":{"enum":["","buyer","seller"],"type":"string","x-enum-varnames":["CommerceTypeNone","CommerceTypeBuyer","CommerceTypeSeller"]},"models.CompanyDefaultBillingSettings":{"properties":{"autoTax":{"type":"boolean"},"generateOrderInvoices":{"type":"boolean"},"paymentTerms":{"$ref":"#/components/schemas/models.PaymentTerms"},"postInvoices":{"type":"boolean"}},"type":"object"},"models.CompanyFlags":{"properties":{"acceptPartialOrders":{"description":"whether or not to partially accept order (allow for some line items to be rejected)","type":"boolean"},"balanceEnabled":{"description":"Whether Balance payment provider is enabled for this company","type":"boolean"},"disableShopifySkuSync":{"description":"Whether to skip SKU updates for Shopify variant sync","type":"boolean"},"ignoreInventoryType":{"description":"always use real inventory count regardless of setting","type":"boolean"},"mergeAllTags":{"description":"Whether to merge seller tags with buyer tags when pushing to buyer platform","type":"boolean"},"notifyCriticalErrors":{"description":"Whether to send a notification email for each new critical error in Convictional","type":"boolean"},"overwriteComparedAtPrice":{"description":"Whether to use overwrite compared at price","type":"boolean"},"pushProductsAsTaxable":{"description":"Whether to push products as taxable to the buyer platform","type":"boolean"},"syncUnpublishedProducts":{"description":"Whether to sync unpublished products, only for sellers, not Magento2 supported","type":"boolean"},"useNewCSVProductWorker":{"description":"Whether to use the new CSV product worker (domains/csvsftp). Otherwise continue using syncProducts worker.","type":"boolean"},"useRetailPriceForComparedAt":{"description":"Whether to use retail price for compared at price","type":"boolean"}},"type":"object"},"models.CompanyPlan":{"properties":{"chargeOrderFee":{"description":"Flag to indicate a fee per order should be charged.","type":"boolean"},"orderFee":{"description":"The fee per order retained by Convictional, as a fractional percent: [0, 1].","type":"number"}},"type":"object"},"models.CompanyPrivacy":{"properties":{"disableSudoAccess":{"description":"Sudo access is enabled by default. This flags disables it.","type":"boolean"}},"type":"object"},"models.CompanySyncing":{"properties":{"getEDIAcknowledgements":{"description":"Whether workers should get edi acknowledgements from the company's order platform","type":"boolean"},"getEDIInventoryUpdates":{"description":"Whether workers should receive EDI inventory updates from the seller","type":"boolean"},"getEDIInvoices":{"description":"Whether workers should receive EDI invoices from the seller","type":"boolean"},"getOrders":{"description":"Whether workers should get orders from the company's order platform","type":"boolean"},"getProducts":{"description":"Whether workers should get products from the company's product platform","type":"boolean"},"getProductsEnd":{"description":"The end time of the last completed product sync","type":"string"},"getProductsStart":{"description":"The start time of the last started product sync","type":"string"},"lastEDIInventoryUpdate":{"description":"The last time an EDI inventory update happens","type":"string"},"postEDIAcknowledgements":{"description":"Whether workers should post edi acknowledgements to the company's order platform","type":"boolean"},"postEDIInventoryUpdate":{"description":"Whether workers should post edi inventory updates to the company's product platform","type":"boolean"},"postEDIInvoices":{"description":"Whether workers should post edi invoices to the company's order platform","type":"boolean"},"postEDIPriceList":{"description":"Whether workers should receive EDI price catalog files","type":"boolean"},"postInvoices":{"description":"Whether workers should process payments for a company's invoiceable orders","type":"boolean"},"postInvoicesDate":{"description":"The start time of the last started invoice sync","type":"string"},"postOrders":{"description":"Whether workers should post orders to the company's order platform","type":"boolean"},"postProducts":{"description":"Whether workers should post products to the company's product platform","type":"boolean"}},"type":"object"},"models.CompanyUser":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"type":"object"},"models.CompanyViewer":{"properties":{"addedByEmail":{"description":"The email of the user that added this viewer","type":"string"},"addedByName":{"description":"The name of the user that added this viewer","type":"string"},"id":{"description":"The Convictional ID of the company that can view this file.","type":"string"},"name":{"description":"The company name that can view the document, ie. \"Mike's Computer\" can see your document.","type":"string"}},"type":"object"},"models.ConsumableActionTemplate":{"properties":{"applyToNewPartners":{"description":"A flag to indicate if this action should be applied to new partnerships. Note: it will not impact existing partnerships.","type":"boolean"},"cardText":{"type":"string"},"cardTitle":{"type":"string"},"companyObjectId":{"type":"string"},"documentId":{"description":"The base document for an agreement when kind=hello_sign.","type":"string"},"emailMessage":{"type":"string"},"emailSubject":{"type":"string"},"id":{"type":"string"},"kind":{"description":"Kind of action that will be presented. Options: [file_upload,text_input]","type":"string"},"optionalDocId":{"type":"string"},"required":{"type":"boolean"},"terms":{"$ref":"#/components/schemas/models.TermsAndConditions"}},"type":"object"},"models.ContactInfo":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"jobTitle":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"},"profile":{"type":"string"}},"type":"object"},"models.Custom":{"properties":{"key":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"models.DataExports":{"properties":{"active":{"type":"boolean"},"exportPath":{"type":"string"},"externalSFTP":{"allOf":[{"$ref":"#/components/schemas/models.ExternalSFTPAuth"}],"description":"Using a separate SFTP auth because the company level auth may be used for a different connection like EDI"},"inventory":{"$ref":"#/components/schemas/models.ExportSettings"}},"type":"object"},"models.Document":{"properties":{"_id":{"description":"The Convictional document ID. Read only.","example":"60c3bf46388d071b1adb2100","type":"string"},"companyId":{"description":"The Convictional ID of the company the document belongs to.","type":"string"},"companyViewers":{"description":"A list of other companies this document is shared with","items":{"$ref":"#/components/schemas/models.CompanyViewer"},"type":"array"},"created":{"description":"The timestamp when the document was originally created by the customer.","example":"2021-06-14T19:27:19.485Z","type":"string"},"deletable":{"description":"If the file is deletable. Read only.","type":"boolean"},"fileName":{"description":"The name of the file","type":"string"},"fileType":{"description":"The MIME type of the file","example":"application/edi-x12","type":"string"},"indexingCompletedAt":{"description":"The timestamp when the document was indexed by the Langchain service","type":"string"},"indexingErroredAt":{"description":"The timestamp when the document failed to index by the Langchain service","type":"string"},"indexingStartedAt":{"description":"The timestamp when the document was sent to the Langchain service for indexing","type":"string"},"sharedWithCompany":{"description":"If the document is visible to the other users of the company or not","type":"boolean"},"size":{"description":"The size of the file, in bytes","type":"integer"},"tags":{"description":"The tags associated with the document.","example":["edi","invoice"],"items":{"type":"string"},"type":"array"},"userId":{"description":"The Convictional ID of the user who uploaded the file.","type":"string"}},"type":"object"},"models.Domain":{"properties":{"isVerified":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"models.EDICounters":{"properties":{"functionalGroupNumber":{"type":"integer"},"interchangeCtrlNum":{"type":"integer"},"invoiceNum":{"type":"integer"},"orderNum":{"type":"integer"}},"type":"object"},"models.EDIData":{"properties":{"acceptedFileExtensions":{"description":"The list of file extensions that are accepted to process an EDI document. If empty, all files. Standard are .x12.","items":{"type":"string"},"type":"array"},"characterEncoding":{"description":"The IANA name of the character encoding they use","type":"string"},"counters":{"$ref":"#/components/schemas/models.EDICounters"},"errors":{"items":{"$ref":"#/components/schemas/models.ErrEDIData"},"type":"array"},"isaID":{"type":"string"},"isaIDQualifier":{"type":"string"},"partnerISAIDOverride":{"description":"When populated, used to override the default ISA ID for all partners","type":"string"},"partnerISAIDQualifierOverride":{"description":"When populated, used to override the default ISA ID qualifier for all partners","type":"string"},"postFulfillment":{"description":"EDI - determines when during order fulfillment to send 856 Ship Notice","enum":["ON_ORDER_COMPLETE","ON_ITEM_COMPLETE"],"type":"string"},"warehouseDefaultMetafieldKey":{"description":"This was how we know where to pull warehouse ID from on the partner metafield, until we fully support locations","type":"string"},"warehouseMetafieldNamespace":{"type":"string"}},"type":"object"},"models.EasyPostSettings":{"type":"object"},"models.ErrEDIData":{"properties":{"message":{"type":"string"}},"type":"object"},"models.ExportInterval":{"enum":["daily","hourly"],"type":"string","x-enum-varnames":["DailyInterval","HourlyInterval"]},"models.ExportSchedule":{"properties":{"hour":{"type":"integer"},"interval":{"$ref":"#/components/schemas/models.ExportInterval"},"location":{"type":"string"},"minute":{"type":"integer"},"nextRun":{"type":"string"}},"type":"object"},"models.ExportSettings":{"properties":{"active":{"type":"boolean"},"lastExportFinish":{"type":"string"},"lastExportStart":{"type":"string"},"schedule":{"$ref":"#/components/schemas/models.ExportSchedule"}},"type":"object"},"models.ExternalSFTPAuth":{"properties":{"address":{"type":"string"},"platform":{"$ref":"#/components/schemas/models.Platform"},"port":{"type":"integer"},"secretID":{"type":"string"},"username":{"type":"string"}},"type":"object"},"models.GettingStarted":{"properties":{"allStepsCompleted":{"description":"This flag declares a company as setup in that current moment. It helps avoid regressing companies back into the onboarding flow.","type":"boolean"},"allStepsCompletedAt":{"description":"This is a timestamp that represents when all steps were marked as completed. Its updated through a worker.","type":"string"},"connectEasyPostSkipped":{"description":"This flag represents if a user has marked that they've skipped connecting EasyPost","type":"boolean"},"ediSpecsReviewCompleted":{"description":"This flag represents if a user has marked that they've reviewed Convictional's EDI specifications.","type":"boolean"},"invitePartnerCompleted":{"description":"options: skipped,completed,\"\" :: whether or not the company has gone through the invite partner getting started card. There are two paths: skipping or inviting team. Once either happen, the card should hide.","type":"string"},"inviteTeamCompleted":{"description":"options: skipped,completed,\"\" :: whether or not the company has gone through the invite team getting started card. There are two paths: skipping or inviting team. Once either happen, the card should hide.","type":"string"},"sftpFileUploadCompleted":{"description":"This flag represents if a user has marked that their desired file (only product file for now) was successfully uploaded to our SFTP server.","type":"boolean"},"testOrderCompleted":{"description":"This flag represents if a user has marked that their test order have been successfully processed in their platform","type":"boolean"}},"type":"object"},"models.GettingStartedResponse":{"properties":{"actionsAssigned":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"activeProducts":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"addBillingAddress":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"addPaymentMethod":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"addReturnsAddress":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"addShippingAddress":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"configureEDISettings":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectBigCommerce":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectEasyPost":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectMagento2":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectPlatform":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectShopify":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectStripe":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"connectWooCommerce":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"createCSVMappings":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"createExternalSFTPCredentials":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"createSFTPCreds":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"createdPriceList":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"doneCount":{"description":"The number of steps that have been completed.","example":0,"type":"integer"},"ediSchemaSetup":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"invitePartners":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"inviteTeam":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"requiredCount":{"description":"The number of required steps that have been completed.","example":0,"type":"integer"},"shippingMethods":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"signedUp":{"description":"If the user has signed up for Convictional yet","example":false,"type":"boolean"},"testOrder":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"uploadSFTPFile":{"$ref":"#/components/schemas/models.OnboardingStateResponse"},"viewEDISpecifications":{"$ref":"#/components/schemas/models.OnboardingStateResponse"}},"type":"object"},"models.ImageSettings":{"properties":{"backgroundColor":{"type":"string"},"fitHeight":{"type":"integer"},"fitWidth":{"type":"integer"},"removeBackground":{"type":"boolean"}},"type":"object"},"models.ImageSettingsUpdate":{"properties":{"backgroundColor":{"type":"string"},"fitHeight":{"type":"integer"},"fitWidth":{"type":"integer"},"removeBackground":{"type":"boolean"}},"type":"object"},"models.Magento2Auth":{"properties":{"platform":{"$ref":"#/components/schemas/models.Platform"},"platformUrl":{"type":"string"},"secretID":{"type":"string"},"storeView":{"type":"string"}},"type":"object"},"models.MarketplaceSettings":{"properties":{"approvalThreshold":{"type":"integer"},"attributes":{"items":{"type":"string"},"type":"array"},"brandCardPhoto":{"type":"string"},"brandDescription":{"type":"string"},"brandHeaderPhoto":{"type":"string"},"brandProfilePhoto":{"type":"string"},"facebookURL":{"type":"string"},"fulfillmentTimes":{"type":"string"},"instagramURL":{"type":"string"},"linkedInURL":{"type":"string"},"location":{"type":"string"},"nsfwProducts":{"type":"boolean"},"onboarded":{"type":"boolean"},"primaryCategories":{"items":{"type":"string"},"type":"array"},"primaryContact":{"$ref":"#/components/schemas/models.ContactInfo"},"retailerAccess":{"type":"string"},"returnPolicyURL":{"type":"string"},"revSplit":{"type":"integer"},"secondaryCategories":{"items":{"type":"string"},"type":"array"},"secondaryContact":{"$ref":"#/components/schemas/models.ContactInfo"},"shippingCountry":{"type":"string"},"shippingRates":{"$ref":"#/components/schemas/models.ShippingRates"},"tags":{"items":{"type":"string"},"type":"array"},"tikTokURL":{"type":"string"},"twitterURL":{"type":"string"},"websiteURL":{"type":"string"},"yearEstablished":{"type":"integer"}},"type":"object"},"models.MerchandisingSettings":{"properties":{"addSellerGpcProductTag":{"type":"boolean"},"addSellerNameProductTag":{"type":"boolean"},"bodyHtmlTemplate":{"type":"string"},"defaultProductTags":{"items":{"type":"string"},"type":"array"},"imageSettings":{"$ref":"#/components/schemas/models.ImageSettings"},"predictCategory":{"type":"boolean"},"pushSellerProductUpdates":{"type":"boolean"},"removeSellerProductTags":{"type":"boolean"},"seoTitleTemplate":{"type":"string"},"titleTemplate":{"type":"string"},"translationSettings":{"$ref":"#/components/schemas/models.TranslationSettings"}},"type":"object"},"models.MerchandisingSettingsUpdate":{"properties":{"addSellerGpcProductTag":{"type":"boolean"},"addSellerNameProductTag":{"type":"boolean"},"bodyHtmlTemplate":{"type":"string"},"defaultProductTags":{"items":{"type":"string"},"type":"array"},"imageSettings":{"$ref":"#/components/schemas/models.ImageSettingsUpdate"},"predictCategory":{"type":"boolean"},"pushSellerProductUpdates":{"type":"boolean"},"removeSellerProductTags":{"type":"boolean"},"seoTitleTemplate":{"type":"string"},"titleTemplate":{"type":"string"},"translationSettings":{"$ref":"#/components/schemas/models.TranslationSettingsUpdate"}},"type":"object"},"models.Metafield":{"properties":{"description":{"description":"Describes the purpose of the metafield","type":"string"},"updated":{"type":"string"},"value":{"description":"Value stored by the field","type":"string"}},"type":"object"},"models.MetafieldSchema":{"properties":{"created":{"type":"string"},"description":{"description":"Describes the purpose of the metafield","type":"string"},"resourceType":{"description":"The collection this metafield schema corresponds to. E.g. partner","type":"string"},"updated":{"type":"string"}},"type":"object"},"models.MetafieldSchemas":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/models.MetafieldSchema"},"type":"object"},"type":"object"},"models.Metafields":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/models.Metafield"},"type":"object"},"type":"object"},"models.OnboardingAttributesUpdate":{"properties":{"commerceType":{"type":"string"},"companyName":{"type":"string"},"companyUrl":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"platform":{"type":"string"},"referralCompanyId":{"type":"string"},"source":{"type":"string"},"storeUrl":{"type":"string"},"temporaryTokenId":{"type":"string"}},"type":"object"},"models.OnboardingStateResponse":{"properties":{"required":{"description":"The onboarding step is required to be completed in order to onboard.","example":false,"type":"boolean"},"status":{"allOf":[{"$ref":"#/components/schemas/models.onboardingStatus"}],"description":"A string representing the state of the onboarding. It can be completed, incomplete or skipped.","example":"completed"}},"type":"object"},"models.PaymentTerms":{"properties":{"numBillingDelayDays":{"description":"number of days to delay billing","type":"integer"}},"type":"object"},"models.PayoutAccountType":{"enum":["","stripe"],"type":"string","x-enum-varnames":["PayoutAccountNone","PayoutAccountStripe"]},"models.PerOrderFee":{"properties":{"appliedFee":{"allOf":[{"$ref":"#/components/schemas/base.MgoMoney"}],"description":"The amount of the flat fee applied to the order in cents"}},"type":"object"},"models.PerOrderFeeType":{"enum":["FIXED","PERCENTAGE"],"type":"string","x-enum-varnames":["PerOrderFeeTypeFixed","PerOrderFeeTypePercentage"]},"models.Platform":{"enum":["shopify","woocommerce","bigcommerce","magento2","csv-sftp","other","external-sftp","edi-sftp","edi-sftp-external"],"type":"string","x-enum-varnames":["PlatformShopify","PlatformWooCommerce","PlatformBigCommerce","PlatformMagento2","PlatformCSVSFTP","PlatformOther","PlatformExternalSFTP","PlatformEDISFTP","PlatformEDIExternalSFTP"]},"models.QuarantineState":{"properties":{"duration":{"description":"How long the quarantine will last","type":"integer"},"reason":{"description":"Human-readable reason","type":"string"},"startTime":{"description":"When quarantine started","type":"string"}},"type":"object"},"models.ReturnsSettings":{"properties":{"shouldRefundOnReturnComplete":{"description":"Set to true to trigger refund on return completion. Defaults to false, which triggers refund on return acceptance.","type":"boolean"},"syncToPlatform":{"description":"Determines whether we will attempt to sync any sort of Returns data to the company's connected platform","type":"boolean"}},"type":"object"},"models.SFTPArchive":{"properties":{"directory":{"description":"Only applicable when Method == ArchiveMethodMove","type":"string"},"method":{"allOf":[{"$ref":"#/components/schemas/models.ArchiveMethod"}],"description":"Defines how to handle archiving for the edi client's SFTP platform","enum":["DELETE","MOVE"]}},"type":"object"},"models.SFTPSettings":{"properties":{"archive":{"$ref":"#/components/schemas/models.SFTPArchive"},"downloadDirectory":{"description":"From our perspective, we download from here","type":"string"},"uploadDirectory":{"description":"From our perspective, we upload to here","type":"string"}},"type":"object"},"models.ShippingOwnership":{"enum":["buyer","seller"],"type":"string","x-enum-varnames":["ShippingOwnershipBuyer","ShippingOwnershipSeller"]},"models.ShippingRate":{"properties":{"flatRate":{"type":"number"},"flatRateMethod":{"type":"string"},"freeShippingMethod":{"type":"string"},"freeShippingThreshold":{"type":"number"}},"type":"object"},"models.ShippingRates":{"properties":{"international":{"$ref":"#/components/schemas/models.ShippingRate"},"us":{"$ref":"#/components/schemas/models.ShippingRate"}},"type":"object"},"models.ShippingSettings":{"properties":{"shippingLabelOwner":{"$ref":"#/components/schemas/models.ShippingOwnership"}},"type":"object"},"models.ShippingSettingsUpdate":{"properties":{"shippingLabelOwner":{"$ref":"#/components/schemas/models.ShippingOwnership"}},"type":"object"},"models.ShopifySettings":{"properties":{"allowFulfillmentServiceSKUSharing":{"description":"If true, this enables \"endless aisle\" style functionality where a buyer can first fulfill from their on-hand inventory before fulfilling from the seller's inventory.","type":"boolean"},"bulkProductSyncDurationSeconds":{"type":"number"},"bulkProductSyncRunning":{"type":"boolean"},"bulkProductSyncTriggeredAt":{"type":"string"},"locationIds":{"description":"LocationIDs Array of Shopify location legacy resource IDs (integers) to limit inventory syncing to specific locations","items":{"type":"integer"},"type":"array"},"paidOrderFilter":{"type":"boolean"},"permissions":{"type":"string"},"platform":{"$ref":"#/components/schemas/models.Platform"},"productCollectionId":{"description":"ProductCollectionID When specified for a seller, only sync products from this collection.","type":"string"},"shareCustomerEmailAddress":{"description":"If true, customer email addresses will be saved in Convictional and shared with sellers. Default false for privacy.","type":"boolean"},"shareCustomerPhoneNumber":{"description":"Buyers only","type":"boolean"},"skipOnHoldOrders":{"description":"If true, when the order has the tag \"hold\" within it. We skip over it till the tag removed.","type":"boolean"},"store":{"type":"string"},"variantMappingReconciliationDurationSeconds":{"type":"number"},"variantMappingReconciliationRunning":{"type":"boolean"},"variantMappingReconciliationTriggeredAt":{"type":"string"}},"type":"object"},"models.TemplateMapping":{"properties":{"dropshipMargin":{"type":"string"},"sellerCompanyName":{"type":"string"}},"type":"object"},"models.TemplateValue":{"properties":{"baseCurrency":{"type":"string"},"dropshipMargin":{"type":"number"},"markup":{"type":"number"},"retailCurrency":{"type":"string"},"sellerCompanyName":{"type":"string"}},"type":"object"},"models.TermsAndConditions":{"properties":{"isTemplate":{"description":"Whether the uploaded file is an editable PDF template","type":"boolean"},"templateMapping":{"allOf":[{"$ref":"#/components/schemas/models.TemplateMapping"}],"description":"Mapping of a PDF field to a Convictional field"},"templateValue":{"allOf":[{"$ref":"#/components/schemas/models.TemplateValue"}],"description":"Values entered into Terms and Conditions used to create a price list on completion"}},"type":"object"},"models.TranslationSettings":{"properties":{"locales":{"description":"Named \"LocaleStrings\" to avoid conflict with \"Locales\" method","items":{"type":"string"},"type":"array"},"translateBody":{"type":"boolean"},"translateTitle":{"type":"boolean"}},"type":"object"},"models.TranslationSettingsUpdate":{"properties":{"locales":{"items":{"type":"string"},"type":"array"},"translateBody":{"type":"boolean"},"translateTitle":{"type":"boolean"}},"type":"object"},"models.Webhook":{"properties":{"id":{"type":"integer"},"key":{"$ref":"#/components/schemas/models.WebhookKey"}},"type":"object"},"models.WebhookKey":{"enum":["uninstall"],"type":"string","x-enum-varnames":["WebhookUninstall"]},"models.WooCommerceSettings":{"properties":{"dimensionUnit":{"description":"The unit of dimension used by the WooCommerce store","type":"string"},"platform":{"$ref":"#/components/schemas/models.Platform"},"platformUrl":{"type":"string"},"weightUnit":{"description":"The unit of weight used by the WooCommerce store","type":"string"}},"type":"object"},"models.onboardingStatus":{"enum":["completed","incomplete","skipped"],"type":"string","x-enum-varnames":["OnboardingCompleted","OnboardingIncomplete","OnboardingSkipped"]},"partners.BillingSettingsUpdate":{"properties":{"autoTax":{"type":"boolean"},"enablePaymentTerms":{"type":"boolean"},"paymentTerms":{"$ref":"#/components/schemas/models.PaymentTerms"},"preferredInvoicePoster":{"type":"string"}},"type":"object"},"partners.InvitedPartner":{"properties":{"buyerAssignedCode":{"description":"Assigned to the buyer or partnership by the seller","type":"string"},"email":{"description":"Address used for invite email, saved as partner.reference afterward","type":"string"},"priceId":{"description":"The id the price list to be used","type":"string"},"sellerAssignedCode":{"description":"Assigned to the seller or partnership by the buyer","type":"string"}},"required":["email"],"type":"object"},"partners.PartnerUpdate":{"properties":{"active":{"description":"Is this supplier or customer active?","example":true,"type":"boolean"},"assignToCompanyObjectId":{"type":"string"},"autoAcceptReturns":{"description":"Whether the seller will automatically accept requested returns","example":true,"type":"boolean"},"billing":{"description":"Are you invoicing in Convictional?","example":true,"type":"boolean"},"billingSettings":{"$ref":"#/components/schemas/partners.BillingSettingsUpdate"},"buyerAssignedCode":{"description":"Assigned to the buyer or partnership by the seller","example":"Supplier-ABC","type":"string"},"maxReturnRate":{"type":"number"},"maxShipTime":{"type":"number"},"merchandisingSettings":{"$ref":"#/components/schemas/models.MerchandisingSettingsUpdate"},"metafields":{"$ref":"#/components/schemas/models.Metafields"},"perOrderFeeSettings":{"$ref":"#/components/schemas/partners.PerOrderFeeSettings"},"pricingId":{"description":"ID of the price list assigned to this customer","example":"abc123","type":"string"},"requireFulfillmentTrackingInfo":{"description":"Whether or not to save fulfillment details if tracking info is not included","type":"boolean"},"sellerAssignedCode":{"description":"Assigned to the seller or partnership by the buyer","example":"Customer-ABC","type":"string"},"shippingSettings":{"$ref":"#/components/schemas/models.ShippingSettingsUpdate"},"syncSellerCompareAtPrice":{"description":"Whether to sync compare at price from the seller (Shopify Only)","type":"boolean"}},"type":"object"},"partners.PerOrderFeeSettings":{"properties":{"flatFee":{"allOf":[{"$ref":"#/components/schemas/base.MgoMoney"}],"description":"The amount of the fixed fee if type fixed in cents"},"percentage":{"description":"The percentage of the per order fee if type percentage","minimum":0,"type":"integer"},"type":{"allOf":[{"$ref":"#/components/schemas/models.PerOrderFeeType"}],"description":"Type of per order fee, either \"fixed\" or \"percentage\"","enum":["FIXED","PERCENTAGE"]}},"type":"object"},"shipping.Method":{"properties":{"carrierNames":{"description":"The names of carriers associated with this shipping method.","items":{"type":"string"},"type":"array"},"companyId":{"description":"The Id of your company.","type":"string"},"createdAt":{"type":"string"},"description":{"description":"Description of this shipping method.","maxLength":500,"type":"string"},"id":{"type":"string"},"maxDays":{"description":"The maximum days it will take to ship.","minimum":0,"type":"integer"},"updatedAt":{"type":"string"}},"required":["companyId"],"type":"object"},"users.MemberRole":{"enum":["","owner"],"type":"string","x-enum-varnames":["MemberRoleNone","MemberRoleOwner"]},"users.UserUpdate":{"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"onboardingAttributes":{"$ref":"#/components/schemas/models.OnboardingAttributesUpdate"},"skipActionCreated":{"type":"boolean"},"skipCriticalCompanyErrorCreated":{"type":"boolean"},"skipFulfillmentPostedToBuyer":{"type":"boolean"},"skipOrderItemsCancelled":{"type":"boolean"},"skipOrderPostedToSeller":{"type":"boolean"},"skipProductAvailableToBuyer":{"type":"boolean"},"skipWeeklyOverviewEmail":{"type":"boolean"}},"type":"object"}}}}